API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Session

beta.chat.create(ChatCreateParams**kwargs) -> ChatCreateResponse

POST/api/v1/chat

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

ParametersExpand Collapse

organization_id: Optional[str]

project_id: Optional[str]

index_ids: Optional[SequenceNotStr[str]]

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

class ChatCreateResponse: …

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

last_updated_at: str

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

session_id: str

Unique session identifier.

generated_title: Optional[str]

Auto-generated title derived from the first user message.

index_ids: Optional[List[str]]

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

job_metadata: Optional[JobMetadata]

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

duration_ms: Optional[float]

error: Optional[str]

export_config_ids: Optional[List[str]]

is_error: Optional[bool]

total_input_tokens: Optional[int]

total_output_tokens: Optional[int]

turns: Optional[int]

Create Session

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
chat = client.beta.chat.create()
print(chat.session_id)

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
  }
}