API ReferenceGuidesChangelog
AI

Create Chat Session

Initialize a new AI chat session. Returns a session_id that can be used with PostSessionMessage to have a conversation with the AI. Messages are generated as part of runs, with is_final indicating run completion.

POST
/v1/ai/chat

Authorization

api-key<token>

In: header

Request Body

application/json

ChatSession represents an interactive conversation session with the AI. Messages in the session are ordered and accessed via cursor positions.

TypeScript Definitions

Use the request body type in TypeScript.

ChatSession represents an interactive conversation session with the AI. Messages in the session are ordered and accessed via cursor positions.

Response Body

application/json

curl -X POST "https://example.com/v1/ai/chat" \  -H "Content-Type: application/json" \  -d '{}'
{  "currentCursorPosition": 0,  "sessionId": "string"}

My Requests

Set up the welcome page for your API to help users make their first call.

Query Chat Session GET

Retrieve information about an existing chat session, returning only messages after the specified cursor position. Messages include run_id to identify generation runs.