DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
Create a new conversation entity. Provide a unique conversation ID, ownership information, and optional metadata.
URI: /api/v1/agentic/conversations
Format: application/json
HTTP Method: POST
Authentication: Bearer JWT
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer JWT token. |
| agent_id | Yes | Registered agent API name. |
| Content-Type | Yes | application/json. |
| Field | Type | Required | Description |
|---|---|---|---|
| conversationId | String | Yes | Caller-supplied unique identifier for this conversation. |
| conversationOwnerId | String | Yes | Individual or User ID of the conversation owner. |
| ownerType | String | Yes | Type of owner. Values: individual, employee. |
| name | String | No | Human-readable name for the conversation. |
| channel | Object | No | Communication channel information. Contains type (web, chat, voice, sms, email, other) and id. |
| variable | Map | No | Arbitrary string key-value metadata. |
1{
2 "conversationId": "conv-2025-001",
3 "conversationOwnerId": "003AB000000XYZ",
4 "ownerType": "individual",
5 "name": "Support — onboarding",
6 "channel": { "type": "chat", "id": "slack-C0123" }
7}| Field | Type | Description |
|---|---|---|
| statusCode | String | Operation status. Value: created. |
| conversationId | String | The created conversation identifier. |
Status: 201 Created
1{
2 "statusCode": "created",
3 "conversationId": "conv-2025-001"
4}| Status Code | Description |
|---|---|
| 400 | Bad Request. Invalid request format or missing required fields. |
| 401 | Unauthorized. Invalid or missing JWT token. |
| 500 | Internal Server Error. |