List Agents - Avala Documentation

GET

agents

cURL

curl --request GET \
  --url https://api.avala.ai/api/v1/agents/ \
  --header 'X-Avala-Api-Key: <api-key>'

{
  "results": [
    {
      "name": "<string>",
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "events": [
        "<string>"
      ],
      "callback_url": "<string>",
      "is_active": true,
      "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_types": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

X-Avala-Api-Key

string

header

required

API key for authentication. Generate one in Mission Control Settings > Security & Identity.

Query Parameters

ordering

string

Which field to use when ordering the results.

cursor

string

The pagination cursor value.

limit

integer

Number of results to return per page.

Response

200 - application/json

results

object[]

required

Show child attributes

string<uri> | null

Create AgentUse this endpoint to create agent in the Avala API using POST on /agents/.

cURL

curl --request GET \
  --url https://api.avala.ai/api/v1/agents/ \
  --header 'X-Avala-Api-Key: <api-key>'

{
  "results": [
    {
      "name": "<string>",
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "events": [
        "<string>"
      ],
      "callback_url": "<string>",
      "is_active": true,
      "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task_types": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}