Skip to main content
GET
/
v2
/
deployments
List all deployments
curl --request GET \
  --url https://api.orq.ai/v2/deployments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "<string>",
      "updated": "<string>",
      "key": "<string>",
      "description": "<string>",
      "prompt_config": {
        "tools": [
          {
            "type": "function",
            "function": {
              "name": "<string>",
              "description": "<string>",
              "strict": true,
              "parameters": {
                "type": "object",
                "properties": {},
                "required": [
                  "<string>"
                ],
                "additionalProperties": true
              }
            },
            "id": 123
          }
        ],
        "model": "<string>",
        "model_type": "chat",
        "model_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"
        },
        "provider": "cohere",
        "messages": [
          {
            "role": "system",
            "content": "<string>",
            "tool_calls": [
              {
                "id": "<string>",
                "index": 123,
                "type": "function",
                "function": {
                  "name": "<string>",
                  "arguments": "<string>"
                }
              }
            ],
            "tool_call_id": "<string>"
          }
        ]
      },
      "version": "<string>"
    }
  ],
  "has_more": true
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

Required range: 1 <= x <= 50
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

Response

List all deployments

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required