Invoke a deployment
Returns a telemetry object with the run’s trace_id and span_id in the response body, used to annotate the span or locate the run in Traces.
telemetry object holding the run’s trace_id and span_id. Use those two values to annotate the span or to locate the run in Traces.
The x-orq-trace-id and x-orq-workflow-run-id headers both carry the workflow run id, which identifies the run’s root span rather than its trace. Despite its name, x-orq-trace-id is not the trace id on this endpoint, and the Annotations API rejects it as one.Authorizations
Body
The deployment request payload
A list of messages to include after the System message, but before the User and Assistant pairs configured in your deployment.
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
- System message
- Developer message
- User message
- Assistant message
- Tool message
A list of messages to send to the deployment.
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
- System message
- Developer message
- User message
- Assistant message
- Tool message
A list of documents from your external knowledge base (e.g., chunks retrieved from your own vector database or RAG pipeline) that provide context for the model response. These documents can be used by evaluators and guardrails to assess the relevance and accuracy of the model output against the provided context.
Response
Successful operation
The provider used to generate the response
openai, groq, cohere, azure, aws, google, google-ai, huggingface, togetherai, perplexity, anthropic, leonardoai, fal, nvidia, jina, elevenlabs, litellm, cerebras, openailike, bytedance, mistral, deepseek, moonshotai, zai, minimax, xai, alibaba, tensorix, scaleway, hcompany, inceptron, wafer, poolside, tencent, nebius, fireworks, baseten, reson8, meta, greenpt, slack, orq List of documents retrieved from the knowledge base. This property is only available when the include_retrievals flag is set to true in the invoke settings. When stream is set to true, the retrievals property will be returned in the last streamed chunk where the property is_final is set to true.