LLM API

Run the unified model response envelope

Runs the selected model and returns a unified response envelope. Tokenizer-backed and lexical-embedding utility models remain deterministic, while configured provider-backed chat and embedding models are routed through the provider service when advertised in GET /v1/models. input also accepts a typed OpenResponses-style array (items shaped {type: message|function_call|function_call_output, ...}) for a real multi-turn conversation with optional tool calling and previous_response_id continuation.

post/v1/responses

Request

  • Base URL: https://api.algenta.ai
  • URL: https://api.algenta.ai/v1/responses
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

modelstring

Utility model identifier from GET /v1/models.

dimensionsinteger

Embedding dimensions when the selected model generates deterministic embeddings.

streamboolean

When true, return Server-Sent Events with deterministic response output events.

parallel_tool_callsboolean nullable

Hint to allow/disallow multiple tool calls in one turn. Best-effort: honored where the provider's API exposes an equivalent knob, otherwise ignored.

previous_response_idstring nullable

Continue a prior typed-input-array conversation: the id of an earlier /v1/responses call whose message history (including any tool calls/results) is prepended before this call's input items. Only valid together with the typed input-array shape. LIMITATION: this history is held in the serving process's memory only -- it does not survive a process restart and will not be found if a later request lands on a different worker/replica than the one that served the original call.

execute_capability_toolsboolean

Track C1 (human-approval pause/resume), OPT-IN and OFF by default. When true, a model tool call in the typed-input-array conversation path whose name resolves to a capability in this org's own GET /v1/capabilities catalog is executed server-side (via the same execute_capability_service that POST /v1/capabilities/execute calls) instead of being returned as an inert tool_call for the caller to run themselves. A capability whose catalog entry sets approval_required=True pauses the response instead of executing (status='approval_required', see ResponsesResponse.approval_required) until a human approves the pending plan through the separate, credentialed POST /v1/capability-executions/{plan_id}/approve endpoint -- this option can never approve a plan itself. Resume the paused response with previous_response_id set to it and a single {type: capability_approval_continuation, plan_id: ...} input item. Default false means zero behavior change for every existing caller.

Response

JSON response envelope by default, or Server-Sent Events when stream=true.

idstring required
object'response'
status'completed' | 'approval_required'
modelstring required
provider_backendstring nullable

Concrete provider backend that served this response when routed uniformly.

provider_model_idstring nullable

Concrete configured provider model that served this response when routed uniformly.

Changes

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