Managing projects and users with the API - Relevance AI Documentation

Relevance AI has APIs for teams to automate their project controls and governance. For up-to-date API docs, please visit the API documentation for the region your organization is hosted in:

In order to use these APIs, you must create an Relevance AI API Key which will have access to your full account. You can generate this from ‘Integrations & API Keys’.

All API references on this page will reference the AU endpoint. Please change the endpoint if your organization is hosted in EU or US.

Projects

Create projects

Creates a project in the specified organization.

curl https://api-f1db6c.stack.tryrelevance.com/latest/projects/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer :<api_key>' \
  --data '{
  "name": "",
  "description": "",
  "organization_id": ""
}'

Response

{
  "project_id": "string"
}

Delete projects

This API endpoint is currently being worked on and is not yet available.

Invites

Invite a user to a project

Permissions Required: Admin

The available actions are:

role:editor for editor permissions
role:viewer for viewer permissions
admin for admin permissions

Notes

In order to update the roles on the user invite, it must first be deleted and then recreated.
If a user is already part of the organization, the invite will be automatically accepted.

curl https://api-f1db6c.stack.tryrelevance.com/latest/auth/invite/create \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <project_id>:<api_key>' \
  --data '{
  "permissions": {
    "items": {
      "relevanceDefault": {
        "actions": {
          "role:editor": true
        }
      }
    },
  },
  "email": ""
}'

Response

{
  "invite_code": "string"
}

Update a user’s role on a project

Permissions Required: Admin

curl 'https://api-f1db6c.stack.tryrelevance.com/latest/auth/users/<user_id>/update' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <project_id>:<api_key>' \
  --data '{
  "permissions": {
    "items": {
	    "relevanceDefault": {
        "actions": {
          "role:editor": true
        }
      }
    }
  }
}'

Delete a project invite

Permissions Required: Admin

curl https://api-f1db6c.stack.tryrelevance.com/latest/auth/invite/delete \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <project id>:<api_key>' \
  --data '{
  "invite_code": ""
}'

Remove a user from a project

Permissions Required: Admin

curl 'https://api-f1db6c.stack.tryrelevance.com/latest/auth/users/{user_id}/delete' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <project id>:<api_key>' \
  --data '{}'

SCIM - enterprise user management

This feature is coming soon!

SCIM support is coming soon to Relevance AI. Currently, enterprises can deactivate users using the WorkOS Dashboard or SCIM API. If a user is marked as deactivated in WorkOS, their accounts and associated API keys will be deactivated immediately. Please see the SCIM docs for WorkOS for documentation on how to use the API.