Get AI agent

GET

/api/v1/workspaces/{workspace_id}/ai_agents/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_agents/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_agents/1 \
  --header 'Authorization: Bearer <token>'

Retrieves a single AI agent by ID.

Authorizations

OAuth2
agents:read

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

AI agent ID

Responses

200

Successful

application/json

object

required

integer

name

required

string

instructions

required

Short custom instructions injected into the build agent’s system prompt.

string | null

skill_ids

required

IDs of the skills assigned to this agent.

Array<integer>

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "id": 12345,
  "name": "My AI Agent",
  "instructions": "Always include a clear call-to-action and avoid jargon.",
  "skill_ids": [
    12345
  ],
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}