Conversations

Run a conversation turn and stream newline-delimited progress events.

Create or recompute a conversation turn using retrieved evidence. This operation can spend credits and has no general Idempotency-Key contract. After a timeout, inspect the conversation before submitting another turn. Streaming errors after headers are sent are delivered in the stream, not as a new HTTP status.

post/v2/conversations/stream

Request

  • Base URL: https://api.machinelibrary.ai
  • URL: https://api.machinelibrary.ai/v2/conversations/stream
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.machinelibrary.ai/v2/oauth/authorize, token URL https://api.machinelibrary.ai/v2/oauth/token, scopes: search)

Request body

conversation_idstring nullable
document_idsstring[]

Exact Nexus documents to merge into retrieval regardless of the query classifier. default keeps historical persisted steps compatible.

idinteger nullable
kindstring
limitinteger
max_model_documentsinteger nullable

Cap on documents sent to the model after reranking and budget stripping (pinned documents keep priority). Experimentation knob for quality/cost sweeps; absent or zero means no cap.

querystring required
resolved_sources_literal_filtersunknown
sources_filtersunknown
sources_literal_filtersunknown

Response

Newline-delimited progress and result events.

Changes

No recorded changes to this operation across all 1 revision of this API.