--- title: "List all deployments" method: GET path: "/v2/deployments" tags: ["Deployments"] --- # List all deployments `GET /v2/deployments` Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first. ## Query parameters - `limit` integer — A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10 - `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 `200` List all deployments - object - `object` 'list', required - `data` object[], required - `id` string, uuid, required — Unique identifier for the object. - `created` string, required — Date in ISO 8601 format at which the object was created. - `updated` string, required — Date in ISO 8601 format at which the object was last updated. - `key` string, required — The deployment unique key - `description` string, required — An arbitrary string attached to the object. Often useful for displaying to users. - `prompt_config` object, required - `tools` object[], required - `display_name` string - `type` 'function', required — The type of the tool. Currently, only `function` is supported. - `function` object, required - `name` string, required — 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` string — A description of what the function does, used by the model to choose when and how to call the function. - `strict` boolean - `parameters` object, required — The parameters the functions accepts, described as a JSON Schema object. Omitting `parameters` defines a function with an empty parameter list. - `type` 'object', required - `properties` object, required - `required` string[] - `additionalProperties` false - `id` number - `model` string, required - `model_type` 'chat' | 'completion' | 'embedding' | 'image' | 'tts' | 'stt' | 'rerank' | 'ocr' | 'moderation' | 'vision', required — The modality of the model - `model_parameters` object, required — Model Parameters: Not all parameters apply to every model - `temperature` number — Only supported on `chat` and `completion` models. - `maxTokens` number — Only supported on `chat` and `completion` models. - `topK` number — Only supported on `chat` and `completion` models. - `topP` number — Only supported on `chat` and `completion` models. - `frequencyPenalty` number — Only supported on `chat` and `completion` models. - `presencePenalty` number — Only supported on `chat` and `completion` models. - `numImages` number — Only supported on `image` models. - `seed` number — Best effort deterministic seed for the model. Currently only OpenAI models support these - `format` 'url' | 'b64_json' | 'text' | 'json_object' — Only supported on `image` models. - `dimensions` string — Only supported on `image` models. - `quality` string — Only supported on `image` models. - `style` string — Only supported on `image` models. - `responseFormat` union — 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. - object - `type` 'json_schema', required - `display_name` string - `json_schema` object, required - … - object - `type` 'json_object', required - object - `type` 'text', required - 'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm' - 'url' | 'base64_json' - 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt' - `cacheControl` object, nullable — Provider-level prompt caching configuration applied to the request. Creates a cache control breakpoint covering the request content. Only supported by `Anthropic` Claude models. - `type` 'ephemeral', required — Create a cache control breakpoint. Accepts only the value "ephemeral". - `ttl` '5m' | '1h' — 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. - `photoRealVersion` 'v1' | 'v2' — The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider - `encoding_format` 'float' | 'base64' — The format to return the embeddings - `reasoningEffort` 'none' | 'disable' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' — 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` number — 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` 'low' | 'medium' | 'high' — Controls the verbosity of the model output. - `thinkingLevel` 'minimal' | 'low' | 'medium' | 'high' — The level of thinking to use for the model. Only supported by `Google AI` - `provider` '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' | 'slack' | 'orq', required - `messages` object[], required - `role` 'system' | 'developer' | 'assistant' | 'user' | 'exception' | 'tool' | 'prompt' | 'correction' | 'expected_output', required — The role of the prompt message - `content` union, required — 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. - string - union[] - union - … - `tool_calls` object[] - `id` string - `index` number - `type` 'function', required - `function` object, required - `name` string, required - `arguments` string, required — JSON string arguments for the functions - `tool_call_id` string, nullable - `version` string, required — THe version of the deployment - `has_more` boolean, required ## Other responses - `500` — Internal Server Error --- [API](https://skmtc.net/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.net/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/versions/1072e5ba28ab/schema)