Logo

Update a conversation

PATCH
/conversations/{conversationId}
/conversations/{conversationId}

Request Body

application/jsonRequired

Update conversation details

titlestring

Title of the conversation

contextobject

Contextual data associated with the conversation

additional_dataobject

Additional data associated with the conversation

Path Parameters

conversationId
Required
integer

The conversation's unique identifier.

curl -X PATCH "https://example.com/conversations/0" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "string",
    "context": {},
    "additional_data": {}
  }'

Conversation updated successfully

{
  "id": 0,
  "is_active": true,
  "user_id": "string",
  "subject_id": "string",
  "assistant_key": "string",
  "title": "string",
  "last_run": {
    "status": "initializing",
    "in_finite_state": true
  },
  "context": [
    {}
  ],
  "additional_data": [
    {}
  ],
  "error": {
    "message": "string"
  },
  "history": [
    {
      "role": "user",
      "run_status": "initializing",
      "messages": [
        {
          "id": "string",
          "content": "string"
        }
      ],
      "actions": [
        {
          "id": "string",
          "role": "tool",
          "content": "string",
          "status": "pending"
        }
      ]
    }
  ],
  "pendingItems": [
    {
      "role": "user",
      "run_status": "initializing",
      "messages": [
        {
          "id": "string",
          "content": "string"
        }
      ],
      "actions": [
        {
          "id": "string",
          "role": "tool",
          "content": "string",
          "status": "pending"
        }
      ]
    }
  ]
}

Previous

Inactivate a conversation DELETE

Next

Create a message POST