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": {}
}
}
]
}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": {}
}
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
Show child attributes
Key-value pairs that match your data model and fields declared in your deployment routing configuration
Show child attributes
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.
Show child attributes
A list of messages to send to the deployment.
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
Show child attributes
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.
Show child attributes
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.
Show child attributes
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
Show child attributes
A filter to apply to the knowledge base chunk metadata when using knowledge bases in the deployment.
Show child attributes
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
Model Parameters: Not all parameters apply to every model
Show child attributes
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
Was this page helpful?