Relevance AI

Relevance AI Auth API

The auth API from Relevance AI — 52 operation(s) for auth.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 52

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /auth/users/create Sign up a new user with an organization and project · CreateUser #
Ask an LLM
“How do I create a new user account along with its first organization and project?”
“Can I sign up a user with an invite code so they join an existing project?”
Tell an agent
Create a user {first_name} {last_name} with organization {organization_name}.
Sign up a new user using invite code {invite_code}.
POST /auth/users/list List users in the project · ListUsers #
Ask an LLM
“Who are the users in my project?”
“Can I filter and sort the project's user list?”
Tell an agent
List the users in this project.
Show project users matching {user_filters}, {page_size} per page.
POST /auth/asset-users/list List who has access to an asset · ListAssetUserPermissions #
Ask an LLM
“Which users have access to a particular agent or tool, and with what role?”
“Can I see everyone's permissions on one shared asset?”
Tell an agent
List user permissions for asset {asset_context}.
Show who can access {asset_context} and their roles.
GET /auth/{asset_type}/{asset_id}/capability Get my capabilities on an asset · GetAssetUserCapability #
Ask an LLM
“What am I allowed to do on a specific asset?”
“Can I check my own capabilities for an agent before editing it?”
Tell an agent
Get my capabilities on {asset_type} {asset_id}.
Check what the current user can do with {asset_type} {asset_id}.
POST /auth/is_authorized Check whether the caller holds given permissions · IsUserAuthorized #
Ask an LLM
“Does my current key have a given set of permissions?”
“Can I test authorization for a relationship on an object before calling it?”
Tell an agent
Check whether I am authorized for {permissions}.
Verify I have relationship {relationship} on object {object}.
GET /auth/info Identify the user and key behind my credentials · GetAuthHeaderInfo #
Ask an LLM
“Which user and key id does my auth header belong to?”
“What permissions does the API key I'm using carry?”
Tell an agent
Show the user id, key id and permissions for my auth header.
Tell me who I'm authenticated as.
POST /auth/invite/create Invite someone to a project · CreateProjectInvite #
Ask an LLM
“How do I invite a teammate to my project by email?”
“Can I invite an existing user by id with a specific role?”
Tell an agent
Invite {email} to this project.
Invite user {user_id} to the project with role {role}.
POST /auth/invite/list List outstanding project invites · ListProjectInvites #
Ask an LLM
“Which project invites are still outstanding?”
“Who have we invited to the project who hasn't joined?”
Tell an agent
List pending project invites.
Show all invites sent for this project.
POST /auth/invite/accept Accept a project invite · AcceptProjectInvite #
Ask an LLM
“I got an invite code - how do I join the project with it?”
“What permissions do I get after accepting a project invite?”
Tell an agent
Accept project invite {invite_code}.
Join the project using invite code {invite_code}.
POST /auth/invite/delete Revoke a project invite · DeleteProjectInvite #
Ask an LLM
“Can I revoke a project invite before it's accepted?”
“How do I delete an invite I sent by mistake?”
Tell an agent destructive · confirm first
Delete project invite {invite_code}.
Revoke the invite with code {invite_code}.
POST /auth/invite/resend Resend a project invite · ResendProjectInvite #
Ask an LLM
“Can I resend an invite that someone didn't receive?”
“Is there a way to nudge an invitee by sending the project invite again?”
Tell an agent
Resend project invite {invite_code}.
Send the invite {invite_code} again.
GET /auth/users/{user_id} Get a user's profile · GetUser #
Ask an LLM
“Can I look up a specific user's profile by id?”
“What details are stored for a given user?”
Tell an agent
Get user {user_id}.
Show the profile of user {user_id}.
POST /auth/users/{user_id}/update Update a user by id, incl. tags and permissions · UpdateUser #
Ask an LLM
“Can I add notes, tags or a label to a user by their id?”
“How do I change another user's permissions in the project?”
Tell an agent
Update user {user_id} with label {label}.
Set permissions {permissions} on user {user_id}.
POST /auth/users/user Update my own profile details · UpdateUserDetails #
Ask an LLM
“How do I change my own name or profile picture?”
“Can I update the email on my own account?”
Tell an agent
Change my name to {first_name} {last_name}.
Update my own email to {email}.
POST /auth/users/{user_id}/delete Remove a user from this project · DeleteUser #
Ask an LLM
“Can I remove someone from my project without affecting their other projects?”
“What happens to a user's access elsewhere when I remove them from the project?”
Tell an agent destructive · confirm first
Remove user {user_id} from this project.
Delete user {user_id} from the project only.
POST /auth/users/request_account_deletion Request deletion of my account · RequestAccountDeletion #
Ask an LLM
“How do I request that my whole account be deleted?”
“Is there a way to close my own user account?”
Tell an agent destructive · confirm first
Request deletion of my account.
Submit a request to delete my user account.
POST /auth/users/{user_id}/keys/create Create an API key for a user · CreateUserKey #
Ask an LLM
“How do I generate a new API key for a user?”
“Can I create a key that expires after a number of hours?”
Tell an agent
Create an API key for user {user_id}.
Create a key labelled {label} for user {user_id} that expires in {ttl_hours} hours.
POST /auth/users/{user_id}/keys/list List a user's API keys · ListUserKeys #
Ask an LLM
“Which API keys does a user have?”
“What keys have been issued to this user id?”
Tell an agent
List API keys for user {user_id}.
Show every key issued to user {user_id}.
POST /auth/users/{user_id}/keys/delete Delete a user's API key · DeleteUserKey #
Ask an LLM
“Can I revoke one of a user's API keys?”
“What happens to integrations using a key once I delete it?”
Tell an agent destructive · confirm first
Delete key {id} for user {user_id}.
Revoke API key {id} belonging to {user_id}.
GET /auth/oauth/options/list List available OAuth providers · ListOAuthOptions #
Ask an LLM
“Which OAuth providers can I connect accounts from?”
“What third-party sign-in options are supported for integrations?”
Tell an agent
List the available OAuth options.
Show which OAuth providers I can connect.
POST /auth/oauth/get_url Start an OAuth connection for a provider · GetOAuthUrl #
Ask an LLM
“How do I start connecting a third-party account via OAuth?”
“Can I reconnect an existing OAuth account to request more scopes?”
Tell an agent
Get an OAuth URL for {provider} with {types} scopes, redirecting to {redirect_url}.
Reauthorize account {existing_oauth_account_id} on {provider} for {types}, returning to {redirect_url}.
POST /mcp/oauth/get_url Start OAuth for a remote MCP server · GetOAuthMCPUrl #
Ask an LLM
“How do I authorize a remote MCP server that requires OAuth?”
“Can I supply my own client id and secret when connecting an MCP server?”
Tell an agent
Start OAuth for MCP server {mcp_name} at {url} in project {project}, redirecting to {redirect_url}.
Authorize MCP {mcp_name} at {url} for project {project} with client {client_id}, returning to {redirect_url}.
GET /auth/oauth/callback Complete an OAuth redirect callback · OAuthCallback #
Ask an LLM
“Where does the OAuth provider send the user back after they authorize?”
“What happens when an OAuth redirect returns an error?”
Tell an agent
Handle the OAuth callback with code {code} and state {state}.
Process the OAuth callback error {error}.
POST /auth/oauth/access_token Get a short-lived access token for a connected account · GetOAuthAccessToken #
Ask an LLM
“Can I get a short-lived OAuth token for client-side use, like a file picker?”
“Which providers allow fetching an access token for a connected account?”
Tell an agent
Get a short-lived access token for {provider} account {account_id}.
Fetch a client-side token for connected account {account_id} on {provider}.
POST /auth/oauth/accounts/list List my connected OAuth accounts · ListOAuthTokenData #
Ask an LLM
“Which OAuth accounts have I connected?”
“Can I filter connected OAuth accounts by asset?”
Tell an agent
List my connected OAuth accounts.
Show OAuth accounts matching {filters}.
POST /auth/accounts/list Search connected provider accounts · ListProviderAccountsData #
Ask an LLM
“Can I search my connected accounts by name and status?”
“Which provider accounts are connected versus disconnected?”
Tell an agent
List provider accounts sorted by {sort_by}, page {page} of {page_size}.
Search accounts for {query} sorted by {sort_by}, page {page}, {page_size} per page.
POST /auth/oauth/accounts/delete Disconnect an OAuth account · DeleteOAuthTokenData #
Ask an LLM
“How do I disconnect an OAuth account I linked?”
“Can I delete a stored OAuth token?”
Tell an agent destructive · confirm first
Delete OAuth account {account_id}.
Disconnect and remove the token for account {account_id}.
POST /auth/pipedream/connect_token Get a Pipedream Connect token · GetPipedreamConnectToken #
Ask an LLM
“How do I get a token to start connecting an account through Pipedream?”
“What is a Pipedream Connect token used for here?”
Tell an agent
Get a Pipedream Connect token.
Issue a new Pipedream Connect token for account linking.
GET /auth/pipedream/apps/{slug_name}/get Check if an app is a Pipedream-backed integration · GetPipedreamApp #
Ask an LLM
“Is a given app integration backed by Pipedream?”
“Can I look up a Pipedream app by its slug?”
Tell an agent
Check whether app {slug_name} is Pipedream backed.
Get the Pipedream app {slug_name}.
POST /auth/pipedream/connect/callback/success Record a successful Pipedream account connection · ConnectPipedreamAccountSuccessCallback #
Ask an LLM
“What gets called after a user successfully connects an account through Pipedream?”
“Can I set sharing when saving a newly connected Pipedream account?”
Tell an agent
Record Pipedream account {account_id} for external user {external_user_id} as connected.
Save connected Pipedream account {account_id} for {external_user_id} with sharing {sharing_permission}.
POST /auth/pipedream/connect/callback/failed Report a failed Pipedream account connection · ConnectPipedreamAccountFailed #
Ask an LLM
“What happens when connecting an account through Pipedream fails?”
“Can I report the error message from a failed Pipedream connection?”
Tell an agent
Report failed Pipedream connection {name} for {provider}: {message}.
Log the Pipedream failure {name} with message {message} on provider {provider}.
GET /auth/arcade/twitter/url Get the OAuth URL for connecting X (Twitter) · GetTwitterURL #
Ask an LLM
“How do I connect an X (Twitter) account through Arcade?”
“Where do I get the authorization link for Twitter?”
Tell an agent
Get the Arcade OAuth URL for X (Twitter).
Give me the link to authorize my Twitter account.
POST /auth/arcade/twitter/callback Complete the X (Twitter) OAuth connection · TwitterOauthCallback #
Ask an LLM
“What finalizes an X (Twitter) connection after the Arcade OAuth window?”
“Can I choose sharing permission when completing the Twitter connection?”
Tell an agent
Complete the Twitter connection with Arcade key {arcade_id_key}.
Finish X OAuth for {arcade_id_key} with sharing {sharing_permission}.
POST /auth/organization/{organization_id}/user/{user_id}/update Change a user's role in an organization · UpdateOrganizationUserPermissions #
Ask an LLM
“How do I make a user an admin of my organization?”
“Can I change someone's organization role?”
Tell an agent
Set user {user_id} in organization {organization_id} admin to {admin}.
Give user {user_id} role {role} in {organization_id} with admin {admin}.
POST /auth/asset/user/{user_id}/update Change a user's role on an asset · UpdateAssetUserPermissions #
Ask an LLM
“Can I give a user editor access to one specific agent?”
“Is it possible to change a user's role on a single shared asset?”
Tell an agent
Give user {user_id} role {role} on asset {asset_context}.
Change {user_id}'s access on {asset_context} to {role}.
POST /auth/accounts/{account_id}/rename Rename a connected account · RenameAccount #
Ask an LLM
“Can I give a connected account a friendlier name?”
“How do I change the label on a linked account?”
Tell an agent
Rename account {account_id} to {label}.
Change the label of connected account {account_id} to {label}.
POST /auth/accounts/{account_id}/namespace Set the namespace of an OAuth account · UpdateOAuthAccountNamespace #
Ask an LLM
“Can I set a namespace on an OAuth account?”
“What does changing a connected account's namespace do?”
Tell an agent
Set namespace {namespace} on OAuth account {account_id}.
Move account {account_id} to namespace {namespace}.
GET /auth/accounts/{account_id}/slack/users/list List Slack users for a connected account · ListSlackUsers #
Ask an LLM
“Who are the Slack users visible to my connected Slack account?”
“Can I see the members of the Slack workspace I linked?”
Tell an agent
List Slack users for account {account_id}.
Show the Slack workspace members on {account_id}.
GET /auth/accounts/{account_id}/slack/channels/list List Slack channels for a connected account · ListSlackChannels #
Ask an LLM
“Which Slack channels can my connected account see?”
“Can I search Slack channels by name or filter by channel type?”
Tell an agent
List Slack channels for account {account_id}.
Search Slack channels on {account_id} for {search_query}.
POST /auth/accounts/{account_id}/slack/dms/open Open Slack DMs with users by email · OpenSlackDmChannels #
Ask an LLM
“How can I make a Slack DM show up as a trigger channel option?”
“Can I open direct message channels with several people by email?”
Tell an agent
Open Slack DMs on account {account_id} with {emails}.
Start direct messages with {emails} via Slack account {account_id}.
GET /auth/accounts/{account_id}/teams/users/list List Microsoft Teams users for an account · ListTeamsUsers #
Ask an LLM
“Which Teams users can my connected Microsoft account see?”
“Can I search Teams users by name and page with a cursor?”
Tell an agent
List Teams users for account {account_id}.
Search Teams users on {account_id} for {search_query}.
GET /auth/accounts/{account_id}/teams/channels/list List Microsoft Teams channels for an account · ListTeamsChannels #
Ask an LLM
“Which Teams channels are available to my connected account?”
“What channels could an agent post to in Microsoft Teams?”
Tell an agent
List Teams channels for account {account_id}.
Show the Microsoft Teams channels on {account_id}.
GET /auth/accounts/{account_id}/teams/groups List Teams group chats (all at once) · ListTeamsGroups #
Ask an LLM
“Which Teams group chats is my connected account part of?”
“Can I get all group chats in one response without paging?”
Tell an agent
List Teams group chats for account {account_id}.
Show every group chat {account_id} participates in, unpaged.
GET /auth/accounts/{account_id}/teams/groups/v2 List Teams group chats with cursor paging · ListTeamsGroupsV2 #
Ask an LLM
“Is there a paginated way to list Teams group chats when there are many?”
“How do I get the next page of Teams group chats using a cursor?”
Tell an agent
List Teams group chats for {account_id} using cursor pagination.
Get the next {page_size} Teams group chats for {account_id} after cursor {cursor}.
GET /auth/accounts/{account_id}/missing-scopes Find missing scopes on an OAuth account · GetMissingScopesForOAuthAccount #
Ask an LLM
“Why is a tool failing - is my connected account missing scopes?”
“Which permissions still need to be granted on an OAuth account?”
Tell an agent
Show missing scopes for OAuth account {account_id}.
Check which scopes account {account_id} still lacks.
GET /auth/accounts/default Get my default account for a provider · GetUserDefaultOAuthAccount #
Ask an LLM
“Which connected account is my default for a provider?”
“What default account will a tool parameter use?”
Tell an agent
Get my default OAuth account for {provider}.
Show the default account used by tool {tool_id}.
POST /auth/accounts/default/upsert Set my default account for a provider · UpsertUserDefaultOAuthAccount #
Ask an LLM
“Can I set which connected account is used by default for a provider?”
“How do I pick a default account for one specific agent?”
Tell an agent
Make {external_account_id} my default {provider} account.
Set {external_account_id} as the default {provider} account for agent {agent_id}.
POST /auth/api-key-user Create an API key user in a project · CreateApiKeyUser #
Ask an LLM
“Can I create a service user that authenticates only with an API key?”
“How do I set up a machine user with specific permissions and tags?”
Tell an agent
Create an API key user {label} with permissions {permissions} and tags {tags}.
Add a service user labelled {label}, tagged {tags}, granted {permissions}.
POST /associations/external/verify-token Verify an external association magic link · VerifyExternalAssociationToken #
Ask an LLM
“Is an external association magic-link token still valid?”
“What does the consent screen show before I link an external identity?”
Tell an agent
Verify external association token {token}.
Check magic-link token {token} and show its consent details.
POST /associations/external/confirm Confirm linking an external identity to my account · ConfirmExternalAssociation #
Ask an LLM
“How do I confirm linking an external identifier to my user?”
“What gets recorded when I accept an external association link?”
Tell an agent
Confirm external association with token {token}.
Link the external identity from magic link {token} to my account.

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-auth-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/data-model/relevance-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relevance-ai:relevance-ai-auth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relevance-ai-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Auth API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:


# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-auth-api-openapi.yml