List conversation agents

GET/v1/conversation-agents

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Response Body

`application/json`

cURL

curl -X GET "https://example.com/conversation-agents"

{
  "success": true,
  "conversationAgents": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "agentType": "prompt",
      "status": "off",
      "isPrimary": true,
      "channels": [
        "string"
      ],
      "modelProvider": "string",
      "modelName": "string",
      "temperature": "string",
      "maxTokens": -9007199254740991,
      "systemPrompt": "string",
      "knowledgeBaseIds": [
        "feff8316-75ff-4581-ba78-f3795ee6b8e7"
      ],
      "toolIds": [
        "95659032-40b7-428d-bf46-562a2c5d3aa2"
      ],
      "goals": [
        null
      ],
      "actions": [
        null
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "unauthorized"
}

{
  "success": false,
  "error": "API key lacks write permission"
}

Authorization

Response Body

200application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`