Skip to main content
PUT
/
v1
/
agents
/
{agent_id}
curl --request PUT \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Agent Name",
    "description": "Updated description"
  }'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "disable_cache": true,
  "cache_failed_jobs": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "engine_class_id": "<string>",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_count": 123,
  "most_recent_job": "<string>",
  "engine_name": "<string>",
  "tags": "<string>",
  "creator": {
    "id": 123,
    "email": "jsmith@example.com",
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.roe-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

curl --request PUT \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated Agent Name",
    "description": "Updated description"
  }'

Path Parameters

​
agent_id
string<uuid>
required

A UUID string identifying this base agent.

Query Parameters

​
organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

application/json

Serializer for updating BaseAgent

​
name
string

New name for the agent. Must not be empty if provided.

Minimum string length: 1
​
disable_cache
boolean

Whether to disable job cache fetching for this agent.

​
cache_failed_jobs
boolean

Whether to cache failed jobs for this agent.

Response

Agent updated successfully.

Serializer for BaseAgent (agent config)

​
id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
name
string
required
Required string length: 1 - 200
​
disable_cache
boolean
required

Whether to disable job cache fetching for this agent.

​
cache_failed_jobs
boolean
required

Whether to cache failed jobs for this agent.

​
organization_id
string<uuid>
required

Organization ID that owns this agent.

​
engine_class_id
string
required
Maximum string length: 200
​
current_version_id
string<uuid>
required
read-only

UUID of the current agent version.

​
job_count
integer | null
required
read-only

Job count from annotation, or None when not fetched (use /agents/job-stats/).

​
most_recent_job
string
required
read-only
​
engine_name
string
required
read-only

Engine Display Name

​
tags
string
required
read-only
​
creator
object