Answerplane Docs
Website Open app
Developers 11 min

Chat and conversation APIs

Send governed questions, stream responses, preserve conversations, and inspect answer metadata.

Chat and conversation APIs

The conversation APIs expose the same governed answer lifecycle used by the Answerplane app.

Integration flow

  1. Authenticate with a server-side key.
  2. Create or reuse a conversation in the intended organization.
  3. Send the user's question and any explicit source or tenant context.
  4. Stream or wait for the answer.
  5. Store the conversation identifier, not source credentials.
  6. Render supported answer blocks and expose provenance.

Use the live API reference for current paths and schemas. The OpenAPI document is the source of truth for request fields.

Render defensively

Treat assistant content as untrusted output. Sanitize links and markup, validate chart blocks, and ignore unsupported block types. Preserve the distinction between narrative, tables, charts, and provenance.

Reliability

Handle authentication, validation, limit, timeout, and upstream source failures separately. Retry only idempotent requests with backoff. Keep an application request ID for correlation.

Tenant safety

Derive tenant context on your server from the authenticated product user. Never accept an arbitrary browser-supplied tenant identifier without authorization.

Start typing to search every guide.