Skip to main content

LLM APIs

Version: aju17f20mq

Use the reference below for request and response fields and operation-specific requirements.

Overview

Manage conversations, messages, tools and semantic memory through the native conversation API. Voice operations require separately enabled voice service, provider credentials and an available voice agent. See Voice availability. Native endpoints do not use the OpenAI wire protocol.

Authentication​

User-facing calls act for the authenticated beneficiary. A backend sk_… key uses an authorized X-On-Behalf-Of selection with users:impersonate; a client pk_… key accompanies that user’s JWT from the configured issuer. Never expose a secret key in a client. Raw identity headers and recipient IDs are not authentication. See Authentication.

Tenant context comes from the authenticated request. Client-supplied X-Tenant-Id, X-User-Id or X-Project-Id do not grant authority. The current public integration uses the default project. Do not rely on project headers for separate project, test/live or customer isolation on this API.

A successful HTTP request can accept work that is still running, queued, awaiting client tools or failed. Inspect the run status and correlate it to the accepted runId; idle conversation state alone is not a terminal receipt for that request. Unknown or absent status means an unknown outcome, not success or proven ongoing execution.

Related guides: Conversations, Agent tools, Memory, Streaming availability

JSON conventions​

Requests accept snake_case or camelCase field names; responses use camelCase. Ordinary default-valued scalars and empty repeated fields can be omitted. Explicitly present optional scalars, map values and well-known JSON types follow their own presence rules: an explicit false, 0 or empty value is not universally equivalent to absence. Decode each field according to its schema. 64-bit integers use JSON strings; preserve their precision. Unknown request fields are generally discarded before validation, so a typo can silently change behavior. This is not a guarantee that arbitrary fields or future client contracts are supported. See API conventions.

Threads​

Conversation containers — create and list threads. See the Conversations guide for thread lifecycle, async generation, and configuration.

Messages​

Send messages and trigger generation. See the Conversations guide for the full message lifecycle and async polling recipe.

Conversations​

Conversation state, settings, and context management. See the Conversations guide.

Feedback​

Rate assistant messages with a thumb or a 1–10 scale, and withdraw ratings. One rating is kept per rater per message; the rater comes from the authenticated caller.

Voice​

Hosted-provider voice sessions; configured voice services and credentials are required.

Tool Approvals​

Manage tool call approval workflows. See the Agent tools guide for the full approval flow.

Client Tools​

Submit results from client-side tool executions. See the Agent tools guide for client-side tool patterns.

MCP Servers​

Discover and introspect registered MCP servers. See the Agent tools guide.

MCP Tools​

List and directly invoke MCP tools. See the Agent tools guide.

MCP Resources​

MCP resource retrieval is not yet available. These endpoints currently return empty responses. See the Agent tools guide.

MCP Prompts​

MCP prompt retrieval is not yet available. These endpoints currently return empty responses. See the Agent tools guide.

Memory​

Semantic memory search and CRUD. See the Memory guide for how memories integrate with conversations.

Server 1​

Travila API

https://api.travila.ai

X-API-Key​

Project/service API key. Use pk_… only with a verified end-user JWT; backend sk_… calls that require a user use authorized on-behalf-of context. Management operations can have different requirements; consult the operation and authentication guide.

X-On-Behalf-Of​

The end user this call acts for. Required with an sk_… key, because a secret key identifies your tenant and not a user; omitting it returns 401 authenticated user_id is required. The key needs the users:impersonate scope or the call fails with 403 insufficient_scope.

Authorization: Bearer​

The end user's own JWT, issued by the OIDC provider configured on the publishable key. Required alongside a pk_… key, and supplies the user identity in place of X-On-Behalf-Of.

Authentication credentials

SettingValue
Security scheme typeapiKey
header parameter nameX-API-Key

Operations​

Document ID: DOC-API-conversations-overview. Section identities and revisions.

SectionStable reference
OverviewDOC-API-conversations-overview#overview
AuthenticationDOC-API-conversations-overview#authentication
JSON conventionsDOC-API-conversations-overview#json-conventions
ThreadsDOC-API-conversations-overview#reference-group-1
MessagesDOC-API-conversations-overview#reference-group-2
ConversationsDOC-API-conversations-overview#reference-group-3
FeedbackDOC-API-conversations-overview#reference-group-4
VoiceDOC-API-conversations-overview#reference-group-5
Tool ApprovalsDOC-API-conversations-overview#reference-group-6
Client ToolsDOC-API-conversations-overview#reference-group-7
MCP ServersDOC-API-conversations-overview#reference-group-8
MCP ToolsDOC-API-conversations-overview#reference-group-9
MCP ResourcesDOC-API-conversations-overview#reference-group-10
MCP PromptsDOC-API-conversations-overview#reference-group-11
MemoryDOC-API-conversations-overview#reference-group-12
Server 1DOC-API-conversations-overview#reference-server-1
X-API-KeyDOC-API-conversations-overview#authentication-apiKeyAuth
X-On-Behalf-OfDOC-API-conversations-overview#authentication-onBehalfOf
Authorization: BearerDOC-API-conversations-overview#authentication-bearerAuth