Skip to main content
GET
/
api
/
v1
/
agents
cURL
curl --request GET \
  --url https://backend.wassist.app/api/v1/agents/ \
  --header 'X-API-Key: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "systemPrompt": "<string>",
      "firstMessage": "<string>",
      "profilePicture": "<string>",
      "tools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "apiSchema": "<unknown>",
          "creditCost": 123,
          "active": true
        }
      ],
      "documents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "file": "<string>",
          "status": "<string>"
        }
      ],
      "memoryKeys": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "<string>",
          "type": "<string>",
          "initialValue": "<string>",
          "whenToUpdate": "<string>"
        }
      ],
      "wakeUpConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "forceMessage": true,
          "enabled": true
        }
      ],
      "outboundTriggers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "templateId": "<string>",
          "templateName": "<string>",
          "secret": "<string>",
          "enabled": true
        }
      ],
      "websiteTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "prompt": "<string>",
          "active": true
        }
      ],
      "imageGenerateTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "creditCost": 123,
          "name": "<string>",
          "description": "<string>",
          "active": true
        }
      ],
      "handoffTools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "parentAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childAgentName": "<string>",
          "description": "<string>",
          "active": true
        }
      ],
      "mcpConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "connectorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "connectorName": "<string>",
          "toolWhitelist": "<unknown>"
        }
      ],
      "paywallConfig": "<string>",
      "adConfig": "<string>",
      "creditSettings": "<string>",
      "voiceCallConfig": "<string>",
      "owner": "<string>",
      "sharings": "<string>",
      "phoneNumbers": [
        {
          "whatsappPhoneNumberId": "<string>",
          "whatsappBusinessAccountId": "<string>",
          "wabaId": "<string>",
          "phoneNumber": "<string>"
        }
      ],
      "totalMessages": "<string>",
      "totalSessions": "<string>",
      "connectUrl": "<string>",
      "ownerActive": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "icebreakers": "<unknown>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"