Skip to main content
POST
/
v2
/
conversations
cURL
curl --request POST \
  --url https://api.orq.ai/v2/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "entityId": "<string>",
    "generatingTitle": true
  },
  "displayName": "Support Chat #1234"
}
'
{
  "entityId": "<string>",
  "kind": "conversation",
  "displayName": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "_id": "conv_01kd6fjj8e7qh48zwfsfwbaba1",
  "createdById": "<string>",
  "updatedById": "<string>",
  "metadata": {
    "generatingTitle": true,
    "entityId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
metadata
object
required
​
displayName
string
default:Untitled

Display name for the conversation. Defaults to "Untitled" if not provided.

Maximum string length: 100
Example:

"Support Chat #1234"

Response

201 - application/json

Conversation successfully created. Returns the complete conversation object including the generated ID and timestamps.

​
entityId
string
required

Identifier of the parent entity (agent, deployment, etc.) this conversation belongs to.

​
kind
enum<string>
required

Type discriminator indicating this is a conversation

Available options:
conversation
​
displayName
string
required

Display name for the conversation. Can be auto-generated or set by the user.

Maximum string length: 100
​
createdAt
number
required

Unix timestamp (in milliseconds) when the conversation was created

​
updatedAt
number
required

Unix timestamp (in milliseconds) when the conversation was last updated

​
_id
string
default:conv_01kd6fjj8e7qh48zwfsfwbaba1

Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the conversation, prefixed with "conv_"

​
createdById
string

Optional identifier of the user or agent that created the conversation

​
updatedById
string

Optional identifier of the user or agent that last updated the conversation

​
metadata
object

Optional metadata associated with the conversation.