Create a New Conversation

POST 
/api/conversations

This endpoint creates a new conversation in a specified workspace. The request must include a valid API key and user ID.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

application/json

Body

required

workspaceId stringrequired

ID of the workspace where the conversation is created.

conversationName string

Name of the conversation. If not provided, a default name will be assigned.

agentId string

ID of the agent associated with the conversation.

Responses

200

Successfully created a new conversation.

application/json

Schema

Schema

conversationId string

The ID of the newly created conversation.

conversation object

The details of the created conversation.

Example (from schema)

{
  "conversationId": "string",
  "conversation": {}
}

400

Invalid request body.

application/json

Schema

Schema

error string

Error message indicating the issue with the request body.

Example (from schema)

{
  "error": "string"
}

403

Invalid API key.

application/json

Schema

Schema

error string

Error message indicating that the API key is invalid.

Example (from schema)

{
  "error": "string"
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...