Relevance AI

Relevance AI Organizations API

The Organizations API from Relevance AI — 55 operation(s) for organizations.

GitHub OpenAPI

Operations 62

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 /organizations/{organization_id}/integrations/overrides/bulk/upsert Bulk set integration permission overrides · BulkUpsertOrganizationIntegrationPermissionOverrides #
Ask an LLM
“Can I allow or block several integrations for my organization in one call?”
“How do I override the default permission for specific integration providers?”
Tell an agent
Apply integration permission overrides {overrides} to organization {org}.
Bulk upsert integration overrides for org {org} using {overrides}.
POST /organizations/{organization_id}/integrations/default Change the default integration permission · UpdateOrganizationDefaultIntegrationPermission #
Ask an LLM
“How do I block all integrations by default for my organization?”
“Can I change the org-wide default status for integrations?”
Tell an agent
Set the default integration permission of org {org} to {integrations_permission_status}.
Change org {org}'s default integration status to {integrations_permission_status}.
GET /organizations/{organization_id}/integrations/default Get the default integration permission · GetOrganizationDefaultIntegrationPermission #
Ask an LLM
“Are integrations allowed by default in my organization?”
“What's the default integration permission status for an org?”
Tell an agent
Get the default integration permission for organization {org}.
Tell me whether new integrations are allowed by default in org {org}.
POST /organizations/{organization_id}/integrations/list List integration providers for an organization · ListOrganizationIntegrationProviders #
Ask an LLM
“Which API key and OAuth integration providers are available to my organization?”
“Can I see each integration's permission override and credentials when listing them?”
Tell an agent
List integration providers for organization {org}.
Search integration providers in org {org} for {query}.
POST /organizations/{organization_id}/keys/set Set an organization-wide native API key · SetOrganizationNativeApiKey #
Ask an LLM
“How do I set a fallback API key for every project in my organization?”
“Which key gets used when a project has no API key of its own?”
Tell an agent
Set native key {key} to {value} for organization {org}.
Store {value} as the org-level {key} key for {org}, shared {is_shared}.
POST /organizations/{organization_id}/keys/delete Delete an organization native API key · DeleteOrganizationNativeApiKey #
Ask an LLM
“How do I remove an org-level native API key?”
“What happens to projects when I delete the organization's fallback key?”
Tell an agent destructive · confirm first
Delete native key {key} from organization {org}.
Remove the org-wide {key} API key for {org}.
POST /organizations/{organization_id}/keys/list List organization native API keys · ListOrganizationNativeApiKeys #
Ask an LLM
“Which native API keys are set at the organization level?”
“Where can I see the org's fallback API keys?”
Tell an agent
List native API keys for organization {org}.
Show the org-level fallback keys for {org}.
POST /organizations/create Create an organization · CreateOrganization #
Ask an LLM
“How do I create a new organization in Relevance AI?”
“Can I name an organization when I create it?”
Tell an agent
Create an organization named {name}.
Set up a new org called {name}.
POST /organizations/{organization_id}/update Rename an organization · UpdateOrganization #
Ask an LLM
“Can I change my organization's name?”
“How do I update an existing organization's details?”
Tell an agent
Rename organization {org} to {name}.
Update org {org} with the name {name}.
GET /organizations/list List my organizations · ListOrganizations #
Ask an LLM
“Which organizations do I belong to?”
“What metadata comes back for each of my organizations?”
Tell an agent
List all my organizations.
Show every org I'm a member of with its metadata.
POST /organizations/{organization_id}/delete Delete an organization · DeleteOrganization #
Ask an LLM
“How do I delete an entire organization?”
“Is deleting an organization something I can undo?”
Tell an agent destructive · confirm first
Delete organization {org}.
Permanently remove org {org}.
GET /organizations/{organization_id}/get Get an organization's details · GetOrganization #
Ask an LLM
“How do I look up one organization's details?”
“What information is stored about my organization?”
Tell an agent
Get organization {org}.
Show the details of org {org}.
GET /organizations/{organization_id}/usage/get Get an organization's usage · GetOrganizationUsage #
Ask an LLM
“How much has my organization used this period?”
“Where can I see usage for my whole organization?”
Tell an agent
Get usage for organization {org}.
Show how much org {org} has consumed.
GET /organizations/plans List available subscription plans · ListOrganizationPlans #
Ask an LLM
“What subscription plans can an organization choose from?”
“Which plans are offered and how do they differ?”
Tell an agent
List the available organization plans.
Show me every subscription plan on offer.
GET /organizations/{organization_id}/users/list List users in an organization · ListUsersInOrganization #
Ask an LLM
“Who are the members of my organization?”
“Can I filter organization users by email?”
Tell an agent
List users in organization {org}.
Find users in org {org} with email {filter_by_email}.
GET /organizations/{organization_id}/projects/list List projects in an organization · ListProjectsInOrganization #
Ask an LLM
“What projects belong to my organization?”
“How many projects does an organization have?”
Tell an agent
List projects in organization {org}.
Show every project under org {org}.
GET /organizations/{organization_id}/invites/list List pending organization invites · ListInvitesInOrganization #
Ask an LLM
“Who has been invited to my organization but not joined yet?”
“Can I see outstanding invites for an org?”
Tell an agent
List invites for organization {org}.
Show the outstanding invitations in org {org}.
POST /organizations/{organization_id}/billing/events/list List an organization's billing events · ListBillingEvents #
Ask an LLM
“Can I see each individual billing event for my organization?”
“How do I filter and page through billing events?”
Tell an agent
List billing events for organization {org}.
List billing events in org {org} matching {filters}.
GET /organizations/{organization_id}/billing/totals Get total spend over a date range · GetBillingTotals #
Ask an LLM
“What did my organization spend over a given date range?”
“Can I total up billing costs for last month?”
Tell an agent
Get billing totals for organization {org} over {date_range}.
Total org {org}'s cost for {date_range}.
GET /organizations/{organization_id}/billing/checkout Get a billing checkout session · GetBillingCheckoutSession #
Ask an LLM
“How do I get a checkout session to add a payment method or subscribe?”
“Can I request a checkout session of a specific type?”
Tell an agent
Get a {type} checkout session for organization {org}.
Fetch a billing checkout session for org {org}.
POST /organizations/{organization_id}/billing/update Change an organization's plan and cycle · UpdateOrganizationBilling #
Ask an LLM
“How do I move my organization to a different plan?”
“Can I switch between monthly and annual billing?”
Tell an agent
Update org {org} billing to plan {plan} on a {billing_cycle} cycle.
Set billing for {org} to {plan}, billed {billing_cycle}.
POST /organizations/{organization_id}/subscription/sync Resync an organization's subscription · SyncSubscription #
Ask an LLM
“My subscription looks out of date, can I force it to resync?”
“How do I refresh the subscription state for an organization?”
Tell an agent
Sync the subscription for organization {org}.
Refresh org {org}'s subscription status.
POST /organizations/get_credit_cost Price a quantity of credits or actions · GetCreditCost #
Ask an LLM
“How much would a given number of credits cost on a plan?”
“Can I price out units before buying them?”
Tell an agent
Get the cost of {units} {type} units.
Price {units} units of {type} on plan {plan}.
POST /organizations/{organization_id}/subscription/downgrade Downgrade an organization's subscription · DowngradeSubscription #
Ask an LLM
“How do I downgrade my organization to a cheaper plan?”
“Can I leave feedback when downgrading my subscription?”
Tell an agent
Downgrade org {org} to plan {plan} with idempotency key {idempotency_key}.
Downgrade {org} to {plan}, noting feedback {feedback}, key {idempotency_key}.
POST /organizations/{organization_id}/billing/subscription/change Switch subscription plan · ChangeBillingSubscription #
Ask an LLM
“How do I change my subscription to a new plan with a coupon?”
“Can I switch plans and billing cycle in one step?”
Tell an agent
Change org {org}'s subscription to {new_plan_name} billed {billing_cycle}, key {idempotency_key}.
Switch {org} to {new_plan_name} {billing_cycle} using coupon {coupon_code}, key {idempotency_key}.
POST /organizations/{organization_id}/downgrade/cancel Cancel a scheduled downgrade · CancelDowngrade #
Ask an LLM
“I scheduled a downgrade by mistake, can I cancel it?”
“How do I keep my current plan after requesting a downgrade?”
Tell an agent
Cancel the pending downgrade for org {org} with key {idempotency_key}.
Undo the scheduled downgrade on {org}, idempotency key {idempotency_key}.
POST /organizations/{organization_id}/subscription/cancel Cancel an organization's subscription · CancelSubscription #
Ask an LLM
“How do I cancel my organization's subscription?”
“What stops when I cancel the paid plan?”
Tell an agent destructive · confirm first
Cancel the subscription for organization {org}.
End org {org}'s paid subscription.
POST /organizations/{organization_id}/credits/buy Buy extra credits · BuyCredits #
Ask an LLM
“How do I top up credits for my organization?”
“Can I buy a specific number of credits right away?”
Tell an agent
Buy {quantity} credits for org {org} with key {idempotency_key}.
Purchase {quantity} extra credits for {org}, idempotency key {idempotency_key}.
POST /organizations/{organization_id}/credits/checkout Start a checkout to buy credits and actions · CreditPurchaseCheckoutSession #
Ask an LLM
“Can I get a checkout page to pay for credits and actions together?”
“Is there a hosted checkout flow for buying credits?”
Tell an agent
Start a checkout for {credits_quantity} credits and {actions_quantity} actions for org {org}.
Create a credit purchase checkout for {org}: {credits_quantity} credits, {actions_quantity} actions.
GET /organizations/{organization_id}/checkout/status Check whether a checkout completed · GetCheckoutCompletionStatus #
Ask an LLM
“Did my checkout payment go through?”
“How can I tell if a checkout session finished?”
Tell an agent
Check the status of checkout {checkout_session_id} for org {org}.
Tell me if org {org}'s last checkout completed.
POST /organizations/{organization_id}/trial/trigger Start a plan trial · TriggerOrganizationPlanTrial #
Ask an LLM
“Can my organization start a free trial of a plan?”
“How do I trigger a plan trial for an org?”
Tell an agent
Start a plan trial for organization {org}.
Trigger the trial for {org} with idempotency key {idempotency_key}.
POST /organizations/{organization_id}/roles/list List assignable roles for an entity type · ListAvailableRolesByScope #
Ask an LLM
“What roles can I assign on projects or other entity types?”
“Which role definitions does my organization support?”
Tell an agent
List the roles available for {entity_type} in org {org}.
Show assignable {entity_type} roles for organization {org}.
GET /organizations/{organization_id}/usage-alarms/list List usage alarms · ListOrganizationUsageAlarms #
Ask an LLM
“What usage alarms are set up for my organization?”
“Where can I see my configured spend thresholds?”
Tell an agent
List usage alarms for organization {org}.
Show the usage alerts configured on {org}.
POST /organizations/{organization_id}/usage-alarms/upsert Create or update a usage alarm · UpsertOrganizationUsageAlarm #
Ask an LLM
“How do I get alerted when usage passes a threshold?”
“Can I change the threshold on an existing usage alarm?”
Tell an agent
Set a {usage_type} alarm on org {org} at {usage_threshold} with action {alarm_action}.
Alert me via {alarm_action} when {org}'s {usage_type} usage reaches {usage_threshold}.
POST /organizations/{organization_id}/usage-alarms/delete Delete a usage alarm · DeleteOrganizationUsageAlarm #
Ask an LLM
“How do I turn off a usage alarm?”
“Can I remove just one alarm action for a usage type?”
Tell an agent destructive · confirm first
Delete the {usage_type} {alarm_action} alarm on org {org}.
Remove {org}'s {alarm_action} alert for {usage_type} usage.
PUT /organizations/{organization_id}/update_features Update an organization's enabled features · UpdateOrganizationEnabledFeatures #
Ask an LLM
“How do I turn features on or off for an organization?”
“Can I change which features are enabled for my org?”
Tell an agent
Set enabled features of org {org} to {features}.
Enable features {features} for organization {org}.
GET /organizations/{organization_id}/features Get an organization's enabled features · GetOrganizationEnabledFeatures #
Ask an LLM
“Which features are enabled for my organization?”
“Is a particular feature switched on for my org?”
Tell an agent
Get enabled features for organization {org}.
List the features turned on for {org}.
POST /organizations/domain-enterprise-check Check if my email domain is enterprise · CheckDomainEnterpriseStatus #
Ask an LLM
“Does my email domain belong to an enterprise organization?”
“Can I tell from a sign-in token whether I should join an enterprise org?”
Tell an agent
Check enterprise status for the domain of ID token {id_token}.
Tell me if the user behind {id_token} is on an enterprise domain.
POST /organizations/check-sso-enforcement Check if an email domain requires SSO · CheckSSOEnforcement #
Ask an LLM
“Does this email address have to sign in with SSO?”
“How do I know if a domain enforces single sign-on?”
Tell an agent
Check whether {email} must use SSO.
Tell me if SSO is enforced for the domain of {email}.
GET /organizations/usage-based-billing-enabled Check if usage-based billing is on · IsUsageBasedBillingEnabled #
Ask an LLM
“Is my organization on usage-based billing?”
“Am I billed by usage or on a fixed plan?”
Tell an agent
Check whether usage-based billing is enabled for my org.
Tell me if my organization pays by usage.
POST /organizations/entitlements/limits/check Check entitlement limits · CheckOrganizationEntitlementLimits #
Ask an LLM
“Has my organization hit its plan limits for certain entitlements?”
“Can I check several entitlements against their limits at once?”
Tell an agent
Check whether entitlements {entitlements} have reached their limits.
Tell me if my org is over the limit for {entitlements}.
GET /organizations/{organization_id}/configuration/{key} Get an organization configuration value · GetOrganizationConfigurationValue #
Ask an LLM
“How do I read a single configuration setting for my organization?”
“What is the value of a given config key on my org?”
Tell an agent
Get configuration key {key} for organization {org}.
Read org {org}'s {key} setting.
GET /organizations/{organization_id}/data_retention Get the data retention policy · GetOrganizationDataRetentionConfig #
Ask an LLM
“How long does my organization keep data?”
“What data retention settings are configured for my org?”
Tell an agent
Get the data retention config for organization {org}.
Show {org}'s data retention period.
PUT /organizations/{organization_id}/data_retention Set the data retention policy · UpsertOrganizationDataRetentionConfig #
Ask an LLM
“How do I have my organization's data deleted after a number of days?”
“Can I change the retention period for my org's data?”
Tell an agent
Set org {org} data retention to {retention_period_days} days with settings {settings}.
Keep data for {retention_period_days} days in {org} using {settings}.
DELETE /organizations/{organization_id}/data_retention Remove the data retention policy · DeleteOrganizationDataRetentionConfig #
Ask an LLM
“How do I remove the custom data retention policy on my org?”
“What happens when I delete a retention configuration?”
Tell an agent destructive · confirm first
Delete the data retention config for organization {org}.
Remove {org}'s custom retention policy.
GET /organizations/{organization_id}/retention-offer/eligibility Check eligibility for a retention discount · GetRetentionOfferEligibility #
Ask an LLM
“Is my organization eligible for a discount if I'm thinking of cancelling?”
“Can I check for a retention offer before I cancel?”
Tell an agent
Check retention offer eligibility for org {org}.
Tell me if {org} qualifies for a retention discount.
POST /organizations/{organization_id}/retention-offer/accept Accept a retention discount · AcceptRetentionOffer #
Ask an LLM
“How do I take the 30% or 50% discount offered instead of cancelling?”
“Can I give a cancellation reason when accepting the retention offer?”
Tell an agent
Accept the retention offer for organization {org}.
Apply the retention discount to {org}, reason {cancellation_reason}.
GET /organizations/{organization_id}/groups List groups in an organization · ListOrganizationGroups #
Ask an LLM
“What user groups exist in my organization?”
“How many users are in each group and what projects can they access?”
Tell an agent
List groups in organization {org}.
Show every group in {org} with user counts.
GET /organizations/{organization_id}/groups/{group_id}/members List members of a group · ListUsersInGroup #
Ask an LLM
“Who is in a particular group?”
“Can I filter a group's members by email?”
Tell an agent
List members of group {group_id} in org {org}.
Find {filter_by_email} among members of group {group_id} in {org}.
GET /organizations/{organization_id}/groups/{group_id}/members/pending List pending members of a group · ListPendingUsersInGroup #
Ask an LLM
“Which invited users haven't joined a group yet?”
“Can I see pending group members separately from active ones?”
Tell an agent
List invited users who have not yet joined group {group_id} in org {org}.
Show users still pending in group {group_id} of {org}.
POST /organizations/{organization_id}/groups/{group_id}/assign_to_project Give a group access to a project · AssignGroupToProject #
Ask an LLM
“How do I give a whole group access to a project?”
“Can I change a group's permission level on a project it already has?”
Tell an agent
Assign group {group_id} to project {project_display_id} with {permission} in org {org}.
Give group {group_id} of {org} {permission} access to project {project_display_id}.
GET /projects/{project_display_id}/group_permissions List groups with access to a project · ListProjectGroupPermissions #
Ask an LLM
“Which groups have permissions on a project?”
“Who can access this project through group membership?”
Tell an agent
List group permissions on project {project_display_id}.
Show which groups can access project {project_display_id}.
DELETE /organizations/{organization_id}/groups/{group_id}/projects/{project_id} Remove a group's access to a project · RemoveGroupFromProject #
Ask an LLM
“How do I revoke a group's access to a project?”
“Does removing a group from a project take away all its permissions there?”
Tell an agent destructive · confirm first
Remove group {group_id} from project {project_id} in org {org}.
Revoke group {group_id}'s access to project {project_id} in {org}.
GET /assets/{asset_type}/{asset_id}/group_permissions List groups with access to an asset · ListAssetGroupPermissions #
Ask an LLM
“Which groups can access a specific agent or tool?”
“Can I see group permissions on a table or workforce?”
Tell an agent
List group permissions on {asset_type} {asset_id}.
Show which groups can use agent {asset_id} of type {asset_type}.
POST /assets/{asset_type}/{asset_id}/group_permissions Grant a group access to an asset · AddGroupAssetPermission #
Ask an LLM
“How do I share an agent or tool with a whole group?”
“Can I give a group a specific permission level on a table?”
Tell an agent
Give group {group_id} {permission} on {asset_type} {asset_id}.
Share {asset_type} {asset_id} with group {group_id} as {permission}.
DELETE /assets/{asset_type}/{asset_id}/group_permissions/{group_id} Revoke a group's access to an asset · RemoveGroupAssetPermission #
Ask an LLM
“How do I stop a group from accessing an agent or tool?”
“Does revoking a group's asset permission work for legacy permissions?”
Tell an agent destructive · confirm first
Remove group {group_id} from {asset_type} {asset_id}.
Revoke group {group_id}'s access to agent {asset_id} of type {asset_type}.
GET /billing/{organization_id}/overage Get overage settings · GetOverageConfig #
Ask an LLM
“Is my organization allowed to go over its credit or action limits?”
“What are the overage settings for concurrency?”
Tell an agent
Get the overage configuration for org {org}.
Show {org}'s overage settings for credits, actions and concurrency.
PUT /billing/{organization_id}/overage Change overage settings · UpdateOverageConfig #
Ask an LLM
“How do I allow my organization to exceed its credit limit?”
“Can I change just the concurrency overage without touching the rest?”
Tell an agent
Set credit overage for org {org} to {credits}.
Update {org}'s concurrency overage to {concurrency}.
GET /billing/{organization_id}/auto-recharge/{currency} Get auto-recharge settings · GetAutoRechargeConfig #
Ask an LLM
“Is auto-recharge turned on for my organization?”
“At what balance does my account top itself up?”
Tell an agent
Get the {currency} auto-recharge config for org {org}.
Show {org}'s auto top-up settings for {currency}.
PUT /billing/{organization_id}/auto-recharge/{currency} Set up auto-recharge · UpsertAutoRechargeConfig #
Ask an LLM
“How do I automatically top up when my balance runs low?”
“Can I change the recharge amount and threshold?”
Tell an agent
Auto-recharge {amount} {currency} for org {org} when the balance drops below {threshold}.
Set {org}'s {currency} top-up to {amount} at threshold {threshold}.
DELETE /billing/{organization_id}/auto-recharge/{currency} Turn off auto-recharge · DeleteAutoRechargeConfig #
Ask an LLM
“How do I stop automatic top-ups?”
“Can I remove auto-recharge for just one currency?”
Tell an agent destructive · confirm first
Delete the {currency} auto-recharge config for org {org}.
Turn off {currency} auto top-up for {org}.

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-organizations-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-organizations-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-organizations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Organizations API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:


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