Skip to main content
PATCH
/
v2
/
conversations
/
{conversation_id}
cURL
curl --request PATCH \
  --url https://api.orq.ai/v2/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Renamed Conversation",
  "metadata": {
    "generatingTitle": true,
    "entityId": "<string>"
  }
}
'
{
  "entityId": "<string>",
  "kind": "conversation",
  "displayName": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "_id": "conv_01kd6fjj8ppaa2f5nj5q1j0ft2",
  "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.

Path Parameters

​
conversation_id
string
required

The unique identifier of the conversation to update

Example:

"conv_01jj1hdhn79xas7a01wb3hysdb"

Body

application/json
​
displayName
string

Updated display name for the conversation.

Maximum string length: 100
Example:

"Renamed Conversation"

​
metadata
object

Optional metadata to update for the conversation.

Response

Conversation successfully updated. Returns the complete updated conversation object.

​
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_01kd6fjj8ppaa2f5nj5q1j0ft2

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.