Find or create conversation

POST

/conversations

Request Body

application/jsonRequired

Conversation find or create

`assistant_key`string

The unique identifier of the assistant.

`user_id`string

The unique identifier of the user.

`subject_id`string

The unique identifier of the subject.

`recreate`boolean

Indicates if the conversation should be recreated if it already exists.

`context`object

Contextual data associated with the conversation.

`additional_data`object

Additional data associated with the conversation.

`title`string

Title of the conversation.

Header Parameters

`x-llm-key`
Required
string

The API key for the LLM provider (e.g., OpenAI).

curl -X POST "https://example.com/conversations" \
  -H "x-llm-key: {{your_llm_provider_key}}" \
  -H "Content-Type: application/json" \
  -d '{
    "assistant_key": "string",
    "user_id": "string",
    "subject_id": "string",
    "recreate": true,
    "context": {},
    "additional_data": {},
    "title": "string"
  }'

Conversation created 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"
        }
      ]
    }
  ]
}

Find or create conversation

Headers

Body

Request Body

assistant_keystring

user_idstring

subject_idstring

recreateboolean

contextobject

Attributes

additional_dataobject