Relevance AI Projects API
The projects API from Relevance AI — 30 operation(s) for projects.
Operations 33
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
Ask an LLM
“How do I create a new project inside my organization?”
“Can I give a new project a description and language when creating it?”
Tell an agent
Create a project named {name} in organization {organization_id}.
Make a new project {name} in {organization_id} described as {description}.
Ask an LLM
“Can I rename my current project or change its description?”
“How do I change the default language of an existing project?”
Tell an agent
Rename the current project to {name}.
Set this project's language to {language}.
Ask an LLM
“Which projects do I have access to?”
“Can I page through all my projects and their metadata?”
Tell an agent
List all my projects.
Show page {page} of my projects, {page_size} per page.
Ask an LLM
“Which organization does my current project belong to?”
“What organization details are attached to this project?”
Tell an agent
Get organization info for the current project.
Show which organization owns this project.
Ask an LLM
“Which third-party keys have been set on my project?”
“What project keys exist right now?”
Tell an agent
List the keys set on this project.
Show which project keys are configured.
GET
/projects/keys/availability
Check API key availability incl. org fallbacks · ListProjectNativeApiKeysAvailability
#
Ask an LLM
“Are API keys available to this project from the organization level if not set on the project?”
“Which native API keys can my project actually use?”
Tell an agent
Show API key availability for this project including organization fallbacks.
Check which native API keys this project can fall back to from its organization.
Ask an LLM
“What kinds of keys can I store on a project?”
“Can I filter the supported project key types by tag?”
Tell an agent
List all valid project key types.
Show project key types tagged {tags}.
Ask an LLM
“How do I store a third-party API key on my project?”
“Can I overwrite a project key with a new value?”
Tell an agent
Set project key {key} to {value}.
Store {value} as the project's {key} key.
Ask an LLM
“Can I remove a stored key from my project?”
“What happens when I delete a project key my tools depend on?”
Tell an agent destructive · confirm first
Delete project key {key}.
Remove the {key} key from this project.
Ask an LLM
“Can I save reusable text snippets at the project level?”
“How do I edit the content of an existing project snippet?”
Tell an agent
Create snippet {name} with content {content} at order {order}.
Update snippet {_id} named {name} to {content} at position {order}.
Ask an LLM
“Which snippets are saved in my project?”
“Can I see where each project snippet is referenced?”
Tell an agent
List this project's snippets.
Show project snippets with their references, {page_size} per page.
Ask an LLM
“Is it possible to delete a snippet from my project?”
“What happens to agents that use a snippet I delete?”
Tell an agent destructive · confirm first
Delete project snippet {id}.
Remove snippet {id} from the project.
POST
/projects/{project_id}/delete_job
Delete a project and all its resources · CreateProjectDeleteJob
#
Ask an LLM
“How do I permanently delete a project and everything in it?”
“Does deleting a project remove all its agents and tools too?”
Tell an agent destructive · confirm first
Delete project {project_id} and all its resources.
Start a job to wipe and delete project {project_id}.
GET
/projects/{project_id}/delete_job
See the latest delete job and resource counts · GetProjectDeletionMetadata
#
Ask an LLM
“Before deleting a project, how many resources does it still contain?”
“Is there already a delete job running for my project?”
Tell an agent
Show the latest delete job and resource counts for project {project_id}.
Check whether project {project_id} has a delete job and what it contains.
GET
/projects/delete_job/{project_deletion_job_id}
Check progress of a project delete job · GetProjectDeleteJob
#
Ask an LLM
“How far along is my project deletion?”
“How many resources are left while a project delete job runs?”
Tell an agent
Get project delete job {project_deletion_job_id}.
Show remaining resources for deletion job {project_deletion_job_id}.
GET
/projects/{project_id}/usage-alarms/list
List a project's usage alarms · ListProjectUsageAlarms
#
Ask an LLM
“What usage alarms are set on my project?”
“Which spending thresholds will alert or block this project?”
Tell an agent
List usage alarms for project {project_id}.
Show every usage threshold alarm on {project_id}.
POST
/projects/{project_id}/usage-alarms/upsert
Create or update a usage alarm · UpsertProjectUsageAlarm
#
Ask an LLM
“Can I get alerted when my project's usage passes a threshold?”
“How do I make a project stop running once usage hits a limit?”
Tell an agent
Set a {usage_type} alarm on project {project_id} at {usage_threshold} with action {alarm_action}.
Change the {alarm_action} alarm for {usage_type} on {project_id} to trigger at {usage_threshold}.
Ask an LLM
“How do I remove a usage alarm from my project?”
“Can I drop just one alarm action for a usage type?”
Tell an agent destructive · confirm first
Delete the {alarm_action} alarm for {usage_type} on project {project_id}.
Remove project {project_id}'s {usage_type} usage alarm with action {alarm_action}.
GET
/projects/{project_id}/usage-alarms/is-blocking
Check if usage alarms are blocking a project · GetIsProjectBlockingOnUsageAlarms
#
Ask an LLM
“Why are my agents being blocked - has a usage alarm tripped?”
“Is my project or its organization currently blocked by usage limits?”
Tell an agent
Check whether project {project_id} is blocked by usage alarms.
Tell me if usage alarms are blocking actions on {project_id}.
GET
/projects/{project_id}/feature_gates
Get features available to a project · GetProjectFeatureGates
#
Ask an LLM
“Which features are enabled for my project?”
“Does this project have access to a particular gated feature?”
Tell an agent
Get feature gates for project {project_id}.
Show the features available on {project_id}.
Ask an LLM
“How can a client subscribe to refresh events across all conversations in a project?”
“Can I get one streaming token for the whole project rather than per conversation?”
Tell an agent
Get a project-wide streaming token.
Issue a streaming token for cross-conversation refresh events in this project.
Ask an LLM
“How do I change one of my project's settings?”
“Can an admin overwrite a project setting value?”
Tell an agent
Set {setting_id} on project {project_id} to {payload}.
Update project {project_id}'s setting {setting_id} with {payload}.
GET
/projects/{project_id}/settings/{setting_id}
Read a single project setting · GetProjectSetting
#
Ask an LLM
“What is the current value of a specific project setting?”
“Can I read one setting on a project by its id?”
Tell an agent
Get setting {setting_id} on project {project_id}.
Show the value of {setting_id} for {project_id}.
Ask an LLM
“Can I fetch several named project settings in one request?”
“What values do a set of project settings currently hold?”
Tell an agent
Get settings {setting_names} for project {project_id}.
Show the values of {setting_names} on {project_id}.
Ask an LLM
“How do I connect an MCP server to my whole project?”
“Will adding an MCP server with a URL that already exists update it instead?”
Tell an agent
Add MCP server {url} to the project as {label}.
Update project MCP server {display_id} to point to {url}.
Ask an LLM
“Which MCP servers are configured for my project?”
“What authentication type does each project MCP server use?”
Tell an agent
List the project's MCP servers.
Show all MCP server configurations with their auth details.
Ask an LLM
“Can I disconnect an MCP server from my project?”
“What if the MCP server I try to delete doesn't exist?”
Tell an agent destructive · confirm first
Delete project MCP server {display_id}.
Remove MCP server {display_id} from this project.
Ask an LLM
“What URL and label does a specific project MCP server have?”
“Can I inspect the auth details of one MCP server by its display id?”
Tell an agent
Get project MCP server {display_id}.
Show URL and auth details of MCP server {display_id}.
GET
/assets/{asset_type}/{asset_id}/access_configuration
Get general access settings for an asset · GetAssetAccessConfiguration
#
Ask an LLM
“Is this agent visible to everyone in the project or only invited people?”
“What role do project members get on a shared asset?”
Tell an agent
Get access configuration for {asset_type} {asset_id}.
Show who can access {asset_type} {asset_id} by default.
POST
/assets/{asset_type}/{asset_id}/access_configuration
Set general access for an asset · SetAssetAccessConfiguration
#
Ask an LLM
“Can I share an asset with everyone in my project at once?”
“How do I restrict an asset to only people I've invited?”
Tell an agent
Set general access for {asset_type} {asset_id}.
Restrict {asset_type} {asset_id} to invited users only.
Ask an LLM
“Which agents, tools or workforces have a custom job priority?”
“What priority tiers are set in this project?”
Tell an agent
List job priority tiers for this project.
Show every entity with a non-default job priority.
POST
/job-priorities/set
Set the job priority for an agent, tool or workforce · SetEntityJobPriority
#
Ask an LLM
“Can I make one agent's jobs run at a higher priority?”
“How do I change the priority tier of a workforce?”
Tell an agent
Set {priority_entity} {entity_id} to priority tier {priority_tier}.
Give {priority_entity} {entity_id} the {priority_tier} job priority.
Ask an LLM
“How do I put an agent back to the default Medium priority?”
“Can I clear a custom priority tier I set on a tool?”
Tell an agent destructive · confirm first
Unset job priority for {priority_entity} {entity_id}.
Revert {priority_entity} {entity_id} to Medium priority.
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