GET
/
v1
/
agents
/
curl --request GET \
  --url https://api.roe-ai.com/v1/agents/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "creator": {
        "id": 123,
        "email": "jsmith@example.com",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "disable_cache": true,
      "cache_failed_jobs": true,
      "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "engine_class_id": "<string>",
      "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "job_count": 123,
      "most_recent_job": "2023-11-07T05:31:56Z",
      "current_version": "<any>",
      "engine_name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organization_id
string

Filter agents by organization ID. If not provided, it lists the user's personal agents.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Response

200
application/json

Successfully retrieved list of agents.

The response is of type object.