Create a conversation agent

POST/v1/conversation-agents

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 200

description?|null

agentType?string

Default"prompt"

Value in"prompt" | "flow"

status?string

Default"off"

Value in"off" | "suggestive" | "auto-pilot"

channels?array<string>

Default[]

modelProvider?string

Value in"openai" | "anthropic" | "google"

modelName?string

temperature?number

Range0 <= value <= 2

maxTokens?integer

Range1 <= value <= 32000

systemPrompt?|null

knowledgeBaseIds?array<>

toolIds?array<>

goals?array<unknown>

actions?array<unknown>

Response Body

`application/json`

cURL

curl -X POST "https://example.com/conversation-agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "success": true,
  "conversationAgent": {
    "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": "validation_failed",
  "message": "string",
  "issues": null
}

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

Authorization

Request Body

Response Body

201application/json

400application/json

403application/json

`application/json`

`application/json`

`application/json`