Skip to main content
GET
/
v0
/
agents
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "llmProvider": "<string>",
  "model": "<string>",
  "instruction": "<string>",
  "channelProvider": "<string>",
  "isConnectedToChannel": true,
  "isActive": true,
  "address": "<string>",
  "name": "<string>",
  "createdBy": "<string>",
  "orgId": "<string>",
  "webhookUrl": "<string>",
  "webhookSecret": "<string>",
  "eventConfigs": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "displayName": "<string>",
      "key": "<string>",
      "description": "<string>",
      "schema": {
        "name": "apppointment_request",
        "schema": {
          "type": "object",
          "properties": {
            "email": {
              "type": "string",
              "description": "The email address of the user."
            },
            "age": {
              "type": "number",
              "description": "The age of the user."
            }
          },
          "required": [
            "email"
          ],
          "additionalProperties": false
        },
        "strict": true
      },
      "waitForResponse": true,
      "stopConversation": true,
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "deletedAt": {}
}

Authorizations

Authorization
string
header
required

Example: Bearer <YOUR_API_KEY>

Path Parameters

id
string
required

Response

id
string
required
llmProvider
string
required
model
string
required
instruction
string
required
channelProvider
string
required
isConnectedToChannel
boolean
required
isActive
boolean
required
address
string
required
name
string
required
createdBy
string
required
orgId
string
required
webhookUrl
string
required
webhookSecret
string
required
eventConfigs
object[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
isDeleted
boolean
required
deletedAt
object
required