Get AI agent

GET

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

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

id

required

integer

AI agent ID

Responses

200

Successful

Media typeapplication/json

object

id

required

integer

name

required

string

company_name

required

string

nullable

company_overview

required

string

nullable

tone

required

string

nullable

guidelines

required

string

nullable

brand_guidelines_document_name

required

string

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "id": 12345,
  "name": "My AI Agent",
  "company_name": "My Company",
  "company_overview": "My Company is a company that makes widgets.",
  "tone": "My Company is a company that makes widgets.",
  "guidelines": "My Company is a company that makes widgets.",
  "brand_guidelines_document_name": "My Company Brand Guidelines",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Unauthorized

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}