Skip to content

List AI agents

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

Retrieves the AI agents

workspace_id
required
integer

Workspace ID

per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

Successful

object
results
required
Array<object>
object
id
required
integer
Example
12345
name
required
string
Example
My AI Agent
company_name
required
string
nullable
Example
My Company
company_overview
required
string
nullable
Example
My Company is a company that makes widgets.
tone
required
string
nullable
Example
My Company is a company that makes widgets.
guidelines
required
string
nullable
Example
My Company is a company that makes widgets.
brand_guidelines_document_name
required
string
nullable
Example
My Company Brand Guidelines
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100

Unauthorized

object
message
required
string
Example
Record not found

Forbidden

object
message
required
string
Example
Record not found