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": "developer",
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "messages": [
    {
      "role": "developer",
      "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,
    "mock_response": "<string>"
  },
  "thread": {
    "id": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "knowledge_filter": {}
}'
{
  "id": "<string>",
  "provider": "<string>",
  "model": "<string>",
  "type": "chat",
  "version": "<string>",
  "messages": [
    {
      "role": "system",
      "content": "<string>",
      "tool_calls": [
        {
          "id": "<string>",
          "index": 123,
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ],
      "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>",
        "description": "<string>",
        "strict": true,
        "schema": {}
      }
    },
    "photoRealVersion": "v1",
    "encoding_format": "float",
    "reasoningEffort": "disable",
    "budgetTokens": 123,
    "verbosity": "low"
  },
  "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
(Developer message · object | System 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 message
  • System message
  • User message
  • Assistant message
  • Tool message
messages
(Developer message · object | System message · object | User message · object | Assistant message · object | Tool message · object)[]

A list of messages to send to the deployment.

  • Developer message
  • System message
  • User message
  • Assistant message
  • Tool message
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 relevant documents that evaluators and guardrails can cite to evaluate the user input or the model response based on your deployment settings.

invoke_options
object
thread
object
knowledge_filter
object

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

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.