Platform APIs
Gateway APIs
curl --request POST \
--url https://api.orq.ai/v2/deployments/get_config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"inputs": {},
"context": {},
"prefix_messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"file_ids": [
"<string>"
],
"metadata": {},
"extra_params": {},
"documents": [
{
"text": "<string>",
"metadata": {
"file_name": "<string>",
"file_type": "<string>",
"page_number": 123
}
}
],
"invoke_options": {
"include_retrievals": false,
"include_usage": false,
"mock_response": "<string>"
},
"thread": {
"id": "<string>",
"tags": [
"<string>"
]
},
"knowledge_filter": {}
}
'{
"id": "<string>",
"provider": "<string>",
"model": "<string>",
"version": "<string>",
"messages": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
},
"id": "<string>",
"index": 123
}
],
"tool_call_id": "<string>"
}
],
"parameters": {
"temperature": 123,
"maxTokens": 123,
"topK": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123,
"numImages": 123,
"seed": 123,
"format": "url",
"dimensions": "<string>",
"quality": "<string>",
"style": "<string>",
"responseFormat": {
"type": "json_schema",
"json_schema": {
"name": "<string>",
"schema": {},
"description": "<string>",
"strict": true
},
"display_name": "<string>"
},
"photoRealVersion": "v1",
"encoding_format": "float",
"reasoningEffort": "none",
"budgetTokens": 123,
"verbosity": "low",
"thinkingLevel": "low"
},
"type": "chat",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
}
}
]
}Get config
Retrieve the deployment configuration
curl --request POST \
--url https://api.orq.ai/v2/deployments/get_config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"inputs": {},
"context": {},
"prefix_messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"file_ids": [
"<string>"
],
"metadata": {},
"extra_params": {},
"documents": [
{
"text": "<string>",
"metadata": {
"file_name": "<string>",
"file_type": "<string>",
"page_number": 123
}
}
],
"invoke_options": {
"include_retrievals": false,
"include_usage": false,
"mock_response": "<string>"
},
"thread": {
"id": "<string>",
"tags": [
"<string>"
]
},
"knowledge_filter": {}
}
'{
"id": "<string>",
"provider": "<string>",
"model": "<string>",
"version": "<string>",
"messages": [
{
"role": "system",
"content": "<string>",
"tool_calls": [
{
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
},
"id": "<string>",
"index": 123
}
],
"tool_call_id": "<string>"
}
],
"parameters": {
"temperature": 123,
"maxTokens": 123,
"topK": 123,
"topP": 123,
"frequencyPenalty": 123,
"presencePenalty": 123,
"numImages": 123,
"seed": 123,
"format": "url",
"dimensions": "<string>",
"quality": "<string>",
"style": "<string>",
"responseFormat": {
"type": "json_schema",
"json_schema": {
"name": "<string>",
"schema": {},
"description": "<string>",
"strict": true
},
"display_name": "<string>"
},
"photoRealVersion": "v1",
"encoding_format": "float",
"reasoningEffort": "none",
"budgetTokens": 123,
"verbosity": "low",
"thinkingLevel": "low"
},
"type": "chat",
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The deployment key to invoke
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
Show child attributes
Show child attributes
The role of the messages author, in this case system.
system The contents of the system message.
An optional name for the participant. Provides the model information to differentiate between participants of the same role.
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
Show child attributes
Show child attributes
The role of the messages author, in this case system.
system The contents of the system message.
An optional name for the participant. Provides the model information to differentiate between participants of the same role.
A list of file IDs that are associated with the deployment request.
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.
Show child attributes
Show child attributes
The text content of the document
Show child attributes
Show child attributes
Whether to include the retrieved knowledge chunks in the response.
Whether to include the usage metrics in the response.
A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage.
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
Show child attributes
Show child attributes
The role of the prompt message
system, assistant, user, exception, tool, prompt, correction, expected_output The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type text or image_url when passing in images. You can pass multiple images by adding multiple image_url content parts. Can be null for tool messages in certain scenarios.
Show child attributes
Show child attributes
function Model Parameters: Not all parameters apply to every model
Show child attributes
Show child attributes
Only supported on chat and completion models.
Only supported on chat and completion models.
Only supported on chat and completion models.
Only supported on chat and completion models.
Only supported on chat and completion models.
Only supported on chat and completion models.
Only supported on image models.
Best effort deterministic seed for the model. Currently only OpenAI models support these
Only supported on image models.
url, b64_json, text, json_object Only supported on image models.
Only supported on image models.
Only supported on image models.
An object specifying the format that the model must output.
Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema
Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.
Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.
Show child attributes
Show child attributes
json_schema Show child attributes
Show child attributes
The version of photoReal to use. Must be v1 or v2. Only available for leonardoai provider
v1, v2 The format to return the embeddings
float, base64 Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
none, disable, minimal, low, medium, high Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking. The minimum budget tokens for thinking are 1024. The Budget Tokens should never exceed the Max Tokens parameter. Only supported by Anthropic
Controls the verbosity of the model output.
low, medium, high The level of thinking to use for the model. Only supported by Google AI
low, high 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.
Show child attributes
Show child attributes
The type of the tool. Currently, only function is supported.
function Show child attributes
Show child attributes
The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
A description of what the function does, used by the model to choose when and how to call the function.
Was this page helpful?