Skip to main content
POST
/
v2
/
deployments
/
get_config
Get config
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": "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
      "metadata": {
        "file_name": "refund_policy.pdf",
        "file_type": "application/pdf",
        "page_number": 1
      }
    },
    {
      "text": "Premium members receive free shipping on all orders over $50.",
      "metadata": {
        "file_name": "membership_benefits.md",
        "file_type": "text/markdown"
      }
    }
  ],
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
key
string
required

The deployment key to invoke

​
inputs
object

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.

​
context
object

Key-value pairs that match your data model and fields declared in your deployment routing configuration

​
prefix_messages
(System message · object | Developer message · object | User message · object | Assistant message · object | Tool message · object)[]

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.

​
messages
(System message · object | Developer message · object | User message · object | Assistant message · object | Tool message · object)[]

A list of messages to send to the deployment.

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

​
file_ids
string[]

A list of file IDs that are associated with the deployment request.

​
metadata
object

Key-value pairs that you want to attach to the log generated by this request.

​
extra_params
object

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.

​
documents
object[]

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.

Example:
[
  {
    "text": "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
    "metadata": {
      "file_name": "refund_policy.pdf",
      "file_type": "application/pdf",
      "page_number": 1
    }
  },
  {
    "text": "Premium members receive free shipping on all orders over $50.",
    "metadata": {
      "file_name": "membership_benefits.md",
      "file_type": "text/markdown"
    }
  }
]
​
invoke_options
object
​
thread
object
​
knowledge_filter
Search operator · object

A filter to apply to the knowledge base chunk metadata when using knowledge bases in the deployment.

Response

Configurations Retrieved.

The deployment configuration

​
id
string
required

A unique identifier for the response. Can be used to add metrics to the transaction.

​
provider
string
required

The provider of the model

​
model
string
required

The model of the configuration

​
version
string
required

The current version of the deployment

​
messages
object[]
required
​
parameters
object
required

Model Parameters: Not all parameters apply to every model

​
type
enum<string>

The type of the model. Current chat,completion and image are supported

Available options:
chat,
completion,
embedding,
image,
tts,
stt,
rerank,
moderation,
vision
​
tools
object[]

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.