Skip to main content
POST
/
v2
/
conversations
curl --request POST \
  --url https://api.orq.ai/v2/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "prj_01jj1hdhn79xas7a01wb3hysdb",
  "displayName": "Customer Support Session",
  "metadata": {
    "generatingTitle": true,
    "entityId": "agent_01jj1hdhn79xas7a01wb3hysdb",
    "model": "openai/gpt-4o"
  }
}
'
{
  "kind": "conversation",
  "displayName": "Product Feature Discussion",
  "createdAt": 1734789600000,
  "updatedAt": 1734793200000,
  "_id": "conv_01jj1hdhn79xas7a01wb3hysdb",
  "createdById": "user_01jj1hdhn79xas7a01wb3hysdb",
  "updatedById": "user_01jj1hdhn79xas7a01wb3hysdb",
  "metadata": {
    "generatingTitle": true,
    "entityId": "agent_01jj1hdhn79xas7a01wb3hysdb",
    "model": "openai/gpt-4o"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
projectId
string
required

Project identifier to associate the conversation with.

Example:

"prj_01jj1hdhn79xas7a01wb3hysdb"

​
displayName
string
default:Untitled

Human-readable name for the conversation. Defaults to "Untitled" if omitted.

Maximum string length: 100
Example:

"Customer Support Session"

​
metadata
object

Optional metadata to attach to the conversation.

Response

201 - application/json

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

​
kind
enum<string>
required

Resource type discriminator.

Available options:
conversation
​
displayName
string
required

Human-readable name for the conversation. Maximum 100 characters.

Maximum string length: 100
Example:

"Product Feature Discussion"

​
createdAt
number
required

Unix timestamp in milliseconds when the conversation was created.

Example:

1734789600000

​
updatedAt
number
required

Unix timestamp in milliseconds when the conversation was last modified.

Example:

1734793200000

​
_id
string
default:conv_01kergnekgeb97k86pqdcgn1sz

Unique conversation identifier with conv_ prefix.

Example:

"conv_01jj1hdhn79xas7a01wb3hysdb"

​
createdById
string

Identifier of the user or system that created the conversation.

Example:

"user_01jj1hdhn79xas7a01wb3hysdb"

​
updatedById
string

Identifier of the user or system that last modified the conversation.

Example:

"user_01jj1hdhn79xas7a01wb3hysdb"

​
metadata
object

Additional conversation metadata.