Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The deployment key to invoke
Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used.
Key-value pairs that match your data model and fields declared in your deployment routing configuration
A list of messages to include after the System message, but before the  User and Assistant pairs configured in your deployment.
- Developer message
- System message
- User message
- Assistant message
- Tool message
A list of messages to send to the deployment.
- Developer message
- System message
- User message
- Assistant message
- Tool message
A list of file IDs that are associated with the deployment request.
Key-value pairs that you want to attach to the log generated by this request.
Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration.
A list of relevant documents that evaluators and guardrails can cite to evaluate the user input or the model response based on your deployment settings.
A filter to apply to the knowledge base chunk metadata when using knowledge bases in the deployment.
- Search operator
- and
- or
Response
Configurations Retrieved.
The deployment configuration
A unique identifier for the response. Can be used to add metrics to the transaction.
The provider of the model
The model of the configuration
The current version of the deployment
Model Parameters: Not all parameters apply to every model
The type of the model. Current chat,completion and image are supported
chat, completion, embedding, image, tts, stt, rerank, moderation, vision A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.