API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Session

$ llamacloud-prod beta:chat create

POST/api/v1/chat

Create a chat session, optionally bound to indexes (locked after the first message).

ParametersExpand Collapse

--organization-id: optional string

Query param

--project-id: optional string

Query param

--index-id: optional array of string

Body param: Indexes this session will retrieve from. Once set and the first message has been sent, the source set is locked for the session’s lifetime. Leave null to create an unbound session.

ReturnsExpand Collapse

BetaChatNewResponse: object { last_updated_at, session_id, generated_title, 2 more }

Summary of a chat session, including its title and last run metadata.

last_updated_at: string

ISO-format timestamp showing when the session was last updated.

session_id: string

Unique session identifier.

generated_title: optional string

Auto-generated title derived from the first user message.

index_ids: optional array of string

Indexes this session is bound to. Null on unbound sessions.

job_metadata: optional object { duration_ms, error, export_config_ids, 4 more }

Token usage and status from the most recent run. Null if the session has not been run yet.

duration_ms: optional number

error: optional string

export_config_ids: optional array of string

is_error: optional boolean

total_input_tokens: optional number

total_output_tokens: optional number

turns: optional number

Create Session

CLI Tool

HTTP

TypeScript

Python

Java

Go

CLI Tool

llamacloud-prod beta:chat create \
  --api-key 'My API Key'

200 example

{
  "last_updated_at": "2026-04-22T12:34:41.342245",
  "session_id": "ses-abc123",
  "generated_title": "What were the main findings in Q3?...",
  "index_ids": [
    "idx-abc123",
    "idx-def456"
  ],
  "job_metadata": {
    "duration_ms": 0,
    "error": "error",
    "export_config_ids": [
      "string"
    ],
    "is_error": true,
    "total_input_tokens": 0,
    "total_output_tokens": 0,
    "turns": 0
  }
}

Returns Examples

200 example

{
  "last_updated_at": "2026-04-22T12:34:41.342245",
  "session_id": "ses-abc123",
  "generated_title": "What were the main findings in Q3?...",
  "index_ids": [
    "idx-abc123",
    "idx-def456"
  ],
  "job_metadata": {
    "duration_ms": 0,
    "error": "error",
    "export_config_ids": [
      "string"
    ],
    "is_error": true,
    "total_input_tokens": 0,
    "total_output_tokens": 0,
    "turns": 0
  }
}