> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List deployment versions
> List saved versions across deployment variants, including drafts, newest first. Resolve the deployment by key or ID. Optionally filter by variant_id. Use the version _id with starting_after or ending_before to paginate.
List saved versions by **Deployment** key or ID. Each version includes its variant ID and saved configuration. Results include drafts and are ordered newest first.
Filter with `variant_id` to retrieve one variant's history. Pass a returned version's `_id` as `starting_after` for the next page or `ending_before` for the previous page.
See [Deployment versioning](/ai-studio/ai-engineering/deployments#versioning) for saving and restoring versions in the UI.
## OpenAPI
````yaml get /v2/deployments/{keyOrID}/versions
openapi: 3.1.0
info:
title: orq.ai API
version: '2.0'
description: orq.ai API documentation
servers:
- url: https://my.orq.ai
security:
- ApiKey: []
tags:
- name: Chunking
description: Split text into smaller chunks for retrieval and generation workflows.
- name: File Systems
description: >-
Create and manage persistent file systems that agents and MCP clients read
from and write to.
- name: Knowledge Bases
description: Create and manage knowledge bases used by agents and retrieval workflows.
- name: Memory Stores
description: Create and manage memory stores, memories, and memory documents.
- name: Evals
description: Run an evaluator against a conversation and its result
- name: Logs
description: >-
OpenTelemetry log query API. Search, filter, aggregate, and facet log
records ingested via OTLP.
- name: Reporting
description: >-
GenAI reporting API over canonical analytics rollups. Accepts a metric
name, time range, grain, group-by, and filters; returns a typed time
series and optional totals.
- name: Traces
description: >-
Query and inspect ingested trace data: search trace summaries, aggregate
metrics, and read individual traces and their spans.
- description: List models available through the AI Router.
name: Models
- name: Policies
- name: Alerts
description: >-
Alerts evaluate a Reporting API metric on a fixed interval and fire
notifications through notifiers when the value breaches a threshold. Each
breach opens a trigger that tracks the incident until the value recovers.
- name: Annotation Queues
description: Annotation queues collect spans for human review.
- name: API keys
description: >-
API keys authenticate programmatic access to the workspace. They expose
opaque tokens, per-domain access grants, and budget and rate-limit
constraints.
- name: Audit Logs
description: Audit logs record workspace entity changes and access-relevant events.
- name: Budgets
description: >-
Budgets govern spend, token usage, and request rate across six scopes:
workspace, project, identity, API key, provider, and model. Every
applicable budget is enforced, and the most restrictive limit applies per
dimension.
- name: Files
description: File upload and retrieval operations.
- name: Guardrail Rules
description: >-
Guardrail Rules conditionally enforce evaluators and plugins for AI
Gateway traffic. Rules may be scoped to a project or the whole workspace.
- name: Hub
description: Hub items are reusable templates available to a workspace.
- name: Identities
description: >-
Identities represent end users from your system for usage and engagement
tracking.
- name: Management keys
description: >-
Management keys are workspace-scoped credentials that authenticate
programmatic access to workspace administration surfaces (API keys,
budgets). Unlike project-scoped API keys, a management key always operates
at the workspace level.
- name: MCP Gateway
description: >-
Register upstream MCP servers, discover and sync their tools, and assemble
gateways that expose a curated tool surface to MCP clients.
- name: Model Catalog
description: >-
Browse the orq.ai model catalog: every model orq offers, across every
provider, with pricing, capabilities and benchmark data. List endpoints
only return models that are not deprecated. This API is public, requires
no authentication, and is rate limited to 120 requests per minute per IP.
Responses carry a 5-minute cache-control max-age.
- name: Monitors
description: >-
Monitors are custom observability dashboards for traces, runtime metrics,
and logs. Each monitor holds widgets that chart one telemetry query. List
the metrics, operations, and dimensions available to your workspace with
`GET /v3/telemetry/capabilities`, or start from a preset with `GET
/v2/monitors/presets`.
- name: Notifiers
description: Notifier destinations used to send delivery and workflow notifications.
- name: Projects
description: Projects organize resources within a workspace
- name: Routing Rules
description: >-
Routing Rules conditionally select models and enforce request plugins for
AI Gateway traffic. Rules are evaluated by ascending priority and may be
scoped to a project or the whole workspace.
- name: Threads
description: Threads group related trace invocations and their aggregate usage
- name: Skills
description: >-
Skills are modular instructions you can use to codify processes and
conventions
- name: Smart Routers
description: >-
Create and manage workspace Smart Routers. A Smart Router selects a model
from an eligible pool for each request according to a quality, balanced,
or cost profile.
- name: Webhooks
description: >-
Create and manage webhooks that deliver workspace events to external HTTPS
endpoints.
- name: Workspaces
description: >-
A workspace is the tenant. Create is called from a user session during
onboarding; Get, List, and Update are the public management surface.
- name: Workspace Security
description: >-
Workspace-level domain verification and IP allowlist controls. These
operations are restricted to workspace administrators.
- name: Workspace Settings
description: >-
Workspace-level settings managed with a workspace credential. A workspace
is the tenant, so these settings are a singleton — there is nothing to
create or delete, only read and update.
- name: Responses
- description: Run agents on a cron cadence. Minimum firing interval is 1 hour.
name: Agent Schedules
- name: Embeddings
- name: Telemetry
description: >-
Unified query envelope for traces, metrics, and logs. One request shape,
one filter dialect, and one response shape per source, validated by a
per-source registry.
- description: Beta. Run typed classification questions against a classify model.
name: Classify
- description: Search Gateway with managed credits or BYOK.
name: Web Search
- description: Beta. Run classification decisions with the classify contract.
name: Decisions
- name: Users
description: >-
Workspace user administration. Requires a Management Key with user
permissions or an authenticated workspace admin session. Standard API keys
are not supported.
externalDocs:
url: https://docs.orq.ai
description: orq.ai Documentation
paths:
/v2/deployments/{keyOrID}/versions:
get:
tags:
- Deployments
summary: List deployment versions
description: >-
List saved versions across deployment variants, including drafts, newest
first. Resolve the deployment by key or ID. Optionally filter by
variant_id. Use the version _id with starting_after or ending_before to
paginate.
operationId: ListDeploymentVersions
parameters:
- schema:
type: string
minLength: 1
description: Deployment key or ID.
required: true
description: Deployment key or ID.
name: keyOrID
in: path
- schema:
type: integer
minimum: 1
maximum: 50
default: 10
description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 50, and the default is 10
required: false
description: >-
A limit on the number of objects to be returned. Limit can range
between 1 and 50, and the default is 10
name: limit
in: query
- schema:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: false
description: Version _id after which to fetch the next page.
required: false
description: Version _id after which to fetch the next page.
name: starting_after
in: query
- schema:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: false
description: Version _id before which to fetch the previous page.
required: false
description: Version _id before which to fetch the previous page.
name: ending_before
in: query
- schema:
type: string
format: uuid
description: Return versions of this variant only.
required: false
description: Return versions of this variant only.
name: variant_id
in: query
responses:
'200':
description: Deployment versions retrieved.
content:
application/json:
schema:
type: object
properties:
object:
enum:
- list
type: string
data:
type: array
items:
type: object
properties:
_id:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The id of the resource
deployment_id:
type: string
variant_id:
type: string
prompt_config:
type: object
properties:
model:
type: string
model_db_id:
type: string
model_type:
type: string
enum:
- chat
- completion
- embedding
- image
- tts
- stt
- rerank
- ocr
- moderation
- classify
- vision
description: The modality of the model
model_parameters:
type: object
properties:
temperature:
type: number
description: >-
Only supported on `chat` and `completion`
models.
maxTokens:
type: number
description: >-
Only supported on `chat` and `completion`
models.
topK:
type: number
description: >-
Only supported on `chat` and `completion`
models.
topP:
type: number
description: >-
Only supported on `chat` and `completion`
models.
frequencyPenalty:
type: number
description: >-
Only supported on `chat` and `completion`
models.
presencePenalty:
type: number
description: >-
Only supported on `chat` and `completion`
models.
numImages:
type: number
description: Only supported on `image` models.
seed:
type: number
description: >-
Best effort deterministic seed for the
model. Currently only OpenAI models support
these
format:
type: string
enum:
- url
- b64_json
- text
- json_object
description: Only supported on `image` models.
dimensions:
type: string
description: Only supported on `image` models.
quality:
type: string
description: Only supported on `image` models.
style:
type: string
description: Only supported on `image` models.
responseFormat:
anyOf:
- type: object
properties:
type:
type: string
enum:
- json_schema
display_name:
type: string
json_schema:
type: object
properties:
name:
type: string
description:
type:
- string
- 'null'
strict:
type: boolean
schema:
type: object
additionalProperties: {}
required:
- name
- schema
required:
- type
- json_schema
- type: object
properties:
type:
type: string
enum:
- json_object
required:
- type
- type: object
properties:
type:
type: string
enum:
- text
required:
- type
- type: string
enum:
- mp3
- opus
- aac
- flac
- wav
- pcm
- type: string
enum:
- url
- base64_json
- type: string
enum:
- json
- text
- srt
- verbose_json
- vtt
- type: 'null'
description: >-
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.
cacheControl:
type:
- object
- 'null'
properties:
type:
description: >-
Create a cache control breakpoint.
Accepts only the value "ephemeral".
enum:
- ephemeral
type: string
ttl:
type: string
enum:
- 5m
- 1h
default: 5m
description: >-
The time-to-live for the cache control
breakpoint. This may be one of the
following values:
- `5m`: 5 minutes
- `1h`: 1 hour
Defaults to `5m`. Only supported by
`Anthropic` Claude models.
required:
- type
description: >-
Provider-level prompt caching configuration
applied to the request. Creates a cache
control breakpoint covering the request
content. Only supported by `Anthropic`
Claude models.
photoRealVersion:
type: string
enum:
- v1
- v2
description: >-
The version of photoReal to use. Must be v1
or v2. Only available for `leonardoai`
provider
encoding_format:
type: string
enum:
- float
- base64
description: The format to return the embeddings
reasoningEffort:
type: string
enum:
- none
- disable
- minimal
- low
- medium
- high
- xhigh
- max
description: >-
Constrains effort on reasoning for reasoning
models. Reducing reasoning effort can result
in faster responses and fewer tokens used on
reasoning in a response.
budgetTokens:
type: number
description: >-
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`
verbosity:
description: Controls the verbosity of the model output.
enum:
- low
- medium
- high
type: string
thinkingLevel:
type: string
enum:
- minimal
- low
- medium
- high
description: >-
The level of thinking to use for the model.
Only supported by `Google AI`
description: >-
Model Parameters: Not all parameters apply to
every model
provider:
type: string
enum:
- openai
- groq
- cohere
- azure
- aws
- google
- google-ai
- huggingface
- togetherai
- perplexity
- anthropic
- leonardoai
- fal
- nvidia
- jina
- elevenlabs
- litellm
- cerebras
- openailike
- bytedance
- mistral
- deepseek
- moonshotai
- zai
- minimax
- xai
- alibaba
- tensorix
- scaleway
- hcompany
- inceptron
- wafer
- poolside
- tencent
- nebius
- fireworks
- baseten
- reson8
- meta
- greenpt
- liquid
- typesafe
- berget
- cloudflare
- slack
- orq
messages:
type: array
items:
type: object
properties:
role:
type: string
enum:
- system
- developer
- assistant
- user
- exception
- tool
- prompt
- correction
- expected_output
description: The role of the prompt message
content:
anyOf:
- type: string
- type: array
items:
oneOf:
- type: object
properties:
type:
type: string
enum:
- text
text:
type: string
required:
- type
- text
description: Text content part of a prompt message
- type: object
properties:
type:
type: string
enum:
- image_url
image_url:
type: object
properties:
id:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The orq.ai id of the image
url:
type: string
description: >-
Either a URL of the image or the base64
encoded data URI.
examples:
- https://picsum.photos/id/1/200/300
- >-
data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z
detail:
type: string
description: >-
Specifies the detail level of the image.
Currently only supported with OpenAI
models
required:
- url
required:
- type
- image_url
description: >-
The image part of the prompt message.
Only supported with vision models.
- type: object
properties:
type:
type: string
enum:
- file
description: >-
The type of the content part. Always
`file`.
file:
type: object
properties:
file_data:
type: string
description: >-
The file data as a data URI string in
the format
'data:;base64,'.
Example:
'data:image/png;base64,iVBORw0KGgoAAAANS...'
uri:
type: string
description: >-
URL to the file. Only supported by
Anthropic Claude models for PDF files.
mimeType:
type: string
description: >-
MIME type of the file (e.g.,
application/pdf, image/png)
filename:
type: string
description: >-
The name of the file, used when passing
the file to the model as a string.
required:
- type
- file
- type: 'null'
description: >-
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.
tool_calls:
type: array
items:
type: object
properties:
id:
type: string
index:
type: number
type:
type: string
enum:
- function
function:
type: object
properties:
name:
type: string
arguments:
type: string
description: JSON string arguments for the functions
required:
- name
- arguments
required:
- type
- function
tool_call_id:
type:
- string
- 'null'
id:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The id of the resource
required:
- role
- content
integration_id:
anyOf:
- type: string
- type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The id of the resource
- type: 'null'
description: The ID of the integration to use
version:
type: string
required:
- model
- model_db_id
- model_type
- model_parameters
- provider
- messages
fallbacks:
type: array
items:
type: object
properties:
model:
type: string
model_db_id:
type: string
model_type:
type: string
enum:
- chat
- completion
- embedding
- image
- tts
- stt
- rerank
- ocr
- moderation
- classify
- vision
description: The modality of the model
model_parameters:
type: object
properties:
temperature:
type: number
description: >-
Only supported on `chat` and `completion`
models.
maxTokens:
type: number
description: >-
Only supported on `chat` and `completion`
models.
topK:
type: number
description: >-
Only supported on `chat` and `completion`
models.
topP:
type: number
description: >-
Only supported on `chat` and `completion`
models.
frequencyPenalty:
type: number
description: >-
Only supported on `chat` and `completion`
models.
presencePenalty:
type: number
description: >-
Only supported on `chat` and `completion`
models.
numImages:
type: number
description: Only supported on `image` models.
seed:
type: number
description: >-
Best effort deterministic seed for the
model. Currently only OpenAI models
support these
format:
type: string
enum:
- url
- b64_json
- text
- json_object
description: Only supported on `image` models.
dimensions:
type: string
description: Only supported on `image` models.
quality:
type: string
description: Only supported on `image` models.
style:
type: string
description: Only supported on `image` models.
responseFormat:
anyOf:
- type: object
properties:
type:
type: string
enum:
- json_schema
display_name:
type: string
json_schema:
type: object
properties:
name:
type: string
description:
type:
- string
- 'null'
strict:
type: boolean
schema:
type: object
additionalProperties: {}
required:
- name
- schema
required:
- type
- json_schema
- type: object
properties:
type:
type: string
enum:
- json_object
required:
- type
- type: object
properties:
type:
type: string
enum:
- text
required:
- type
- type: string
enum:
- mp3
- opus
- aac
- flac
- wav
- pcm
- type: string
enum:
- url
- base64_json
- type: string
enum:
- json
- text
- srt
- verbose_json
- vtt
- type: 'null'
description: >-
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.
cacheControl:
type:
- object
- 'null'
properties:
type:
description: >-
Create a cache control breakpoint.
Accepts only the value "ephemeral".
enum:
- ephemeral
type: string
ttl:
type: string
enum:
- 5m
- 1h
default: 5m
description: >-
The time-to-live for the cache control
breakpoint. This may be one of the
following values:
- `5m`: 5 minutes
- `1h`: 1 hour
Defaults to `5m`. Only supported by
`Anthropic` Claude models.
required:
- type
description: >-
Provider-level prompt caching
configuration applied to the request.
Creates a cache control breakpoint
covering the request content. Only
supported by `Anthropic` Claude models.
photoRealVersion:
type: string
enum:
- v1
- v2
description: >-
The version of photoReal to use. Must be
v1 or v2. Only available for `leonardoai`
provider
encoding_format:
type: string
enum:
- float
- base64
description: The format to return the embeddings
reasoningEffort:
type: string
enum:
- none
- disable
- minimal
- low
- medium
- high
- xhigh
- max
description: >-
Constrains effort on reasoning for
reasoning models. Reducing reasoning
effort can result in faster responses and
fewer tokens used on reasoning in a
response.
budgetTokens:
type: number
description: >-
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`
verbosity:
description: >-
Controls the verbosity of the model
output.
enum:
- low
- medium
- high
type: string
thinkingLevel:
type: string
enum:
- minimal
- low
- medium
- high
description: >-
The level of thinking to use for the
model. Only supported by `Google AI`
description: >-
Model Parameters: Not all parameters apply to
every model
provider:
type: string
enum:
- openai
- groq
- cohere
- azure
- aws
- google
- google-ai
- huggingface
- togetherai
- perplexity
- anthropic
- leonardoai
- fal
- nvidia
- jina
- elevenlabs
- litellm
- cerebras
- openailike
- bytedance
- mistral
- deepseek
- moonshotai
- zai
- minimax
- xai
- alibaba
- tensorix
- scaleway
- hcompany
- inceptron
- wafer
- poolside
- tencent
- nebius
- fireworks
- baseten
- reson8
- meta
- greenpt
- liquid
- typesafe
- berget
- cloudflare
- slack
- orq
integration_id:
anyOf:
- type: string
- type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The id of the resource
- type: 'null'
description: The ID of the integration to use
version:
type: string
required:
- model
- model_db_id
- model_type
- model_parameters
- provider
tools:
type: array
items:
allOf:
- type: object
properties:
display_name:
type: string
type:
type: string
enum:
- function
description: >-
The type of the tool. Currently, only
`function` is supported.
function:
type: object
properties:
name:
type: string
description: >-
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.
description:
type: string
description: >-
A description of what the function does,
used by the model to choose when and how
to call the function.
strict:
type: boolean
parameters:
type: object
properties:
type:
type: string
enum:
- object
properties:
type: object
additionalProperties: {}
required:
type: array
items:
type: string
additionalProperties:
type: boolean
enum:
- false
required:
- type
- properties
description: >-
The parameters the functions accepts,
described as a JSON Schema object.
Omitting `parameters` defines a function with an empty parameter list.
required:
- name
- parameters
required:
- type
- function
- type: object
properties:
id:
type: number
variables:
type: array
items:
type: object
properties:
key:
type: string
value: {}
is_pii:
type: boolean
default: false
description:
type: string
required:
- key
notes:
type: string
timestamp:
type: string
format: date-time
retry_count:
type: number
version:
type: string
description:
type: string
status:
type: string
enum:
- live
- draft
- pending
- published
user_id:
type:
- string
- 'null'
knowledge_bases:
type: array
items:
type: object
properties:
id:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
default: 01M4Y3RK2ZKFV54M7FM4PH6MR0
readOnly: true
description: >-
The unique identifier of the playground
knowledge base
knowledge_id:
type: string
format: ulid
pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
readOnly: true
description: The linked Knowledge ID
configuration:
anyOf:
- type: object
properties:
type:
type: string
enum:
- last_user_message
required:
- type
title: Knowledge base last user message
description: >-
Defines the configuration settings for a
last user message type retrieval.
- type: object
properties:
type:
type: string
enum:
- query
query:
type: string
required:
- type
- query
title: Knowledge base static query
description: >-
Defines the configuration settings for a
static query.
title: Knowledge base configuration
description: >-
Defines the configuration settings which can
either be for a user message or a text entry.
required:
- knowledge_id
- configuration
default: []
settings:
type: object
properties:
guardrails:
type: array
items:
type: object
properties:
id:
type: string
description: Unique key or identifier of the evaluator
sample_rate:
type: number
minimum: 1
maximum: 100
default: 50
description: >-
The percentage of executions to evaluate
with this evaluator (1-100). For example,
a value of 50 means the evaluator will run
on approximately half of the executions.
execute_on:
type: string
enum:
- input
- output
- both
description: >-
Determines whether the evaluator runs on
the agent input (user message) or output
(agent response).
required:
- id
- execute_on
evaluators:
type: array
items:
type: object
properties:
id:
type: string
description: Unique key or identifier of the evaluator
sample_rate:
type: number
minimum: 1
maximum: 100
default: 50
description: >-
The percentage of executions to evaluate
with this evaluator (1-100). For example,
a value of 50 means the evaluator will run
on approximately half of the executions.
execute_on:
type: string
enum:
- input
- output
- both
description: >-
Determines whether the evaluator runs on
the agent input (user message) or output
(agent response).
required:
- id
- execute_on
cache:
oneOf:
- type: object
properties:
enabled:
type: boolean
enum:
- false
required:
- enabled
- type: object
properties:
enabled:
type: boolean
enum:
- true
type:
type: string
enum:
- exact
- semantic
ttl:
type: number
required:
- enabled
- type
- ttl
guardrailBehaviour:
type: string
enum:
- none
- retry
- fallback
engine:
type: string
enum:
- text
- jinja
- mustache
input_masking:
type: boolean
default: false
system_masking:
type: boolean
default: false
output_masking:
type: boolean
default: false
required:
- _id
- deployment_id
- variant_id
- prompt_config
- fallbacks
- tools
- variables
- timestamp
- version
- description
- status
- user_id
has_more:
type: boolean
required:
- object
- data
- has_more
'400':
description: Invalid query parameters.
'401':
description: Authentication required.
'403':
description: Insufficient deployment permissions.
'404':
description: Deployment not found or inaccessible.
x-code-samples:
- lang: typescript
label: TypeScript
source: |-
import { Orq } from '@orq-ai/node';
const orq = new Orq({ apiKey: process.env.ORQ_API_KEY ?? '' });
const versions = await orq.deployments.listVersions({
keyOrID: 'customer-support',
limit: 10,
});
components:
securitySchemes:
ApiKey:
type: http
scheme: bearer
bearerFormat: JWT
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.