> ## 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. # Get config > Retrieve the deployment configuration ## OpenAPI ````yaml post /v2/deployments/get_config openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://api.orq.ai security: - ApiKey: [] tags: - name: Guardrail Rules - name: Policies - name: Routing Rules - name: Files description: File upload and retrieval operations. - name: FilesService - name: Projects description: Projects organize resources within a workspace - name: ProjectsService - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: SkillsService - name: Responses - description: >- Run agents on a cadence — cron, interval, or one-off. Minimum firing interval is 1 hour. name: Agent Schedules - 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: ReportingService description: |- ReportingService exposes a single QueryReport RPC that maps allowlisted analytics payloads onto safe rollup queries. Callers never send SQL; the backend picks the rollup family and grain from the metric catalogue, the requested range, and the requested grouping. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/deployments/get_config: post: tags: - Deployments summary: Get config description: Retrieve the deployment configuration operationId: DeploymentGetConfig requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: The deployment key to invoke inputs: type: object additionalProperties: {} description: >- 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: type: object additionalProperties: {} description: >- Key-value pairs that match your data model and fields declared in your deployment routing configuration prefix_messages: type: array items: oneOf: - type: object properties: role: type: string enum: - system description: >- The role of the messages author, in this case `system`. content: anyOf: - type: string description: The contents of the system message. - type: array items: $ref: '#/components/schemas/TextContentPartSchema' minItems: 1 description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. description: The contents of the system message. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - role - content title: System message description: >- Developer-provided instructions that the model should follow, regardless of messages sent by the user. - type: object properties: role: type: string enum: - developer description: >- The role of the messages author, in this case `developer`. content: anyOf: - type: string description: The contents of the system message. - type: array items: $ref: '#/components/schemas/TextContentPartSchema' minItems: 1 description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. description: The contents of the developer message. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - role - content title: Developer message - type: object properties: role: type: string enum: - user description: >- The role of the messages author, in this case `user`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. content: anyOf: - type: string description: The text contents of the message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: >- #/components/schemas/ImageContentPartSchema - $ref: >- #/components/schemas/AudioContentPartSchema - type: object properties: type: type: string enum: - file description: >- The type of the content part. Always `file`. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 file: $ref: >- #/components/schemas/FileContentPartSchema required: - type - file description: >- An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs. description: The contents of the user message. required: - role - content title: User message - type: object properties: content: anyOf: - type: string description: The contents of the assistant message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: '#/components/schemas/RefusalPartSchema' - $ref: '#/components/schemas/ReasoningPartSchema' - $ref: >- #/components/schemas/RedactedReasoningPartSchema discriminator: propertyName: type mapping: text: $ref: >- #/components/schemas/TextContentPartSchema refusal: $ref: '#/components/schemas/RefusalPartSchema' reasoning: $ref: '#/components/schemas/ReasoningPartSchema' redacted_reasoning: $ref: >- #/components/schemas/RedactedReasoningPartSchema description: >- An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. - type: 'null' description: >- The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. refusal: type: - string - 'null' description: The refusal message by the assistant. role: type: string enum: - assistant description: >- The role of the messages author, in this case `assistant`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. audio: type: - object - 'null' properties: id: type: string description: >- Unique identifier for a previous audio response from the model. required: - id description: >- Data about a previous audio response from the model. tool_calls: type: array items: type: object properties: id: type: string description: The ID of the tool call. 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 call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. thought_signature: type: string description: >- Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call. required: - id - type - function description: >- The tool calls generated by the model, such as function calls. required: - role title: Assistant message - type: object properties: role: type: string enum: - tool description: >- The role of the messages author, in this case tool. content: anyOf: - type: string - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema discriminator: propertyName: type mapping: text: $ref: >- #/components/schemas/TextContentPartSchema description: The contents of the tool message. tool_call_id: type: - string - 'null' description: Tool call that this message is responding to. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 required: - role - content - tool_call_id title: Tool message description: >- A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment. messages: type: array items: oneOf: - type: object properties: role: type: string enum: - system description: >- The role of the messages author, in this case `system`. content: anyOf: - type: string description: The contents of the system message. - type: array items: $ref: '#/components/schemas/TextContentPartSchema' minItems: 1 description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. description: The contents of the system message. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - role - content title: System message description: >- Developer-provided instructions that the model should follow, regardless of messages sent by the user. - type: object properties: role: type: string enum: - developer description: >- The role of the messages author, in this case `developer`. content: anyOf: - type: string description: The contents of the system message. - type: array items: $ref: '#/components/schemas/TextContentPartSchema' minItems: 1 description: >- An array of content parts with a defined type. For system messages, only type `text` is supported. description: The contents of the developer message. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. required: - role - content title: Developer message - type: object properties: role: type: string enum: - user description: >- The role of the messages author, in this case `user`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. content: anyOf: - type: string description: The text contents of the message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: >- #/components/schemas/ImageContentPartSchema - $ref: >- #/components/schemas/AudioContentPartSchema - type: object properties: type: type: string enum: - file description: >- The type of the content part. Always `file`. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 file: $ref: >- #/components/schemas/FileContentPartSchema required: - type - file description: >- An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs. description: The contents of the user message. required: - role - content title: User message - type: object properties: content: anyOf: - type: string description: The contents of the assistant message. - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema - $ref: '#/components/schemas/RefusalPartSchema' - $ref: '#/components/schemas/ReasoningPartSchema' - $ref: >- #/components/schemas/RedactedReasoningPartSchema discriminator: propertyName: type mapping: text: $ref: >- #/components/schemas/TextContentPartSchema refusal: $ref: '#/components/schemas/RefusalPartSchema' reasoning: $ref: '#/components/schemas/ReasoningPartSchema' redacted_reasoning: $ref: >- #/components/schemas/RedactedReasoningPartSchema description: >- An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. - type: 'null' description: >- The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. refusal: type: - string - 'null' description: The refusal message by the assistant. role: type: string enum: - assistant description: >- The role of the messages author, in this case `assistant`. name: type: string description: >- An optional name for the participant. Provides the model information to differentiate between participants of the same role. audio: type: - object - 'null' properties: id: type: string description: >- Unique identifier for a previous audio response from the model. required: - id description: >- Data about a previous audio response from the model. tool_calls: type: array items: type: object properties: id: type: string description: The ID of the tool call. 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 call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. thought_signature: type: string description: >- Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call. required: - id - type - function description: >- The tool calls generated by the model, such as function calls. required: - role title: Assistant message - type: object properties: role: type: string enum: - tool description: >- The role of the messages author, in this case tool. content: anyOf: - type: string - type: array items: oneOf: - $ref: >- #/components/schemas/TextContentPartSchema discriminator: propertyName: type mapping: text: $ref: >- #/components/schemas/TextContentPartSchema description: The contents of the tool message. tool_call_id: type: - string - 'null' description: Tool call that this message is responding to. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 required: - role - content - tool_call_id title: Tool message description: A list of messages to send to the deployment. identity: $ref: '#/components/schemas/PublicIdentity' file_ids: type: array items: type: string description: >- A list of file IDs that are associated with the deployment request. metadata: type: object additionalProperties: {} description: >- Key-value pairs that you want to attach to the log generated by this request. extra_params: type: object additionalProperties: {} description: >- 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: type: array items: type: object properties: text: type: string description: The text content of the document metadata: type: object properties: file_name: type: string description: Name of the file the text is from. file_type: type: string description: Content type of the file the text is from. page_number: type: number description: The page number the text is from. description: Metadata about the document required: - text description: >- 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: type: object properties: include_retrievals: type: boolean default: false description: >- Whether to include the retrieved knowledge chunks in the response. include_usage: type: boolean default: false description: Whether to include the usage metrics in the response. mock_response: type: string description: >- A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage. thread: type: object properties: id: type: string description: Unique thread identifier to group related invocations. tags: type: array items: type: string description: Optional tags to differentiate or categorize threads required: - id knowledge_filter: anyOf: - type: object additionalProperties: anyOf: - type: object properties: eq: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - eq title: eq description: Equal to - type: object properties: ne: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - ne title: ne description: Not equal to - type: object properties: gt: type: number required: - gt title: gt description: Greater than - type: object properties: gte: type: number required: - gte title: gte description: Greater than or equal to - type: object properties: lt: type: number required: - lt title: lt description: Less than - type: object properties: lte: type: number required: - lte title: lte description: Less than or equal to - type: object properties: in: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - in title: in description: In - type: object properties: nin: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - nin title: nin description: Not in - type: object properties: exists: type: boolean required: - exists title: exists description: Exists title: Search operator - type: object properties: and: type: array items: type: object additionalProperties: anyOf: - type: object properties: eq: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - eq title: eq description: Equal to - type: object properties: ne: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - ne title: ne description: Not equal to - type: object properties: gt: type: number required: - gt title: gt description: Greater than - type: object properties: gte: type: number required: - gte title: gte description: Greater than or equal to - type: object properties: lt: type: number required: - lt title: lt description: Less than - type: object properties: lte: type: number required: - lte title: lte description: Less than or equal to - type: object properties: in: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - in title: in description: In - type: object properties: nin: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - nin title: nin description: Not in - type: object properties: exists: type: boolean required: - exists title: exists description: Exists required: - and title: and description: And - type: object properties: or: type: array items: type: object additionalProperties: anyOf: - type: object properties: eq: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - eq title: eq description: Equal to - type: object properties: ne: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - ne title: ne description: Not equal to - type: object properties: gt: type: number required: - gt title: gt description: Greater than - type: object properties: gte: type: number required: - gte title: gte description: Greater than or equal to - type: object properties: lt: type: number required: - lt title: lt description: Less than - type: object properties: lte: type: number required: - lte title: lte description: Less than or equal to - type: object properties: in: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - in title: in description: In - type: object properties: nin: type: array items: anyOf: - type: string title: string description: String - type: number title: number description: Number - type: boolean title: boolean description: Boolean required: - nin title: nin description: Not in - type: object properties: exists: type: boolean required: - exists title: exists description: Exists required: - or title: or description: Or description: >- A filter to apply to the knowledge base chunk metadata when using knowledge bases in the deployment. required: - key responses: '200': description: Configurations Retrieved. content: application/json: schema: type: object properties: id: type: string description: >- A unique identifier for the response. Can be used to add metrics to the transaction. provider: type: string description: The provider of the model model: type: string description: The model of the configuration type: type: string enum: - chat - completion - embedding - image - tts - stt - rerank - ocr - moderation - vision description: >- The type of the model. Current `chat`,`completion` and `image` are supported version: type: string description: The current version of the deployment 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' required: - role - content 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: enum: - json_schema type: string display_name: type: string json_schema: type: object properties: name: type: string description: type: string 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. 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 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: type: string enum: - low - medium - high description: Controls the verbosity of the model output. thinkingLevel: type: string enum: - 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' tools: type: array items: type: object properties: 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. parameters: type: object additionalProperties: {} description: >- The parameters the functions accepts, described as a JSON Schema object. Omitting `parameters` defines a function with an empty parameter list. required: - name required: - type - function description: >- 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. required: - id - provider - model - version - messages - parameters description: The deployment configuration '204': description: No content - successful operation '401': description: Unauthorized. components: schemas: TextContentPartSchema: type: object properties: type: type: string enum: - text description: The type of the content part. text: type: string description: The text content. cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 required: - type - text title: Text content part description: The type of the content part. ImageContentPartSchema: type: object properties: type: type: string enum: - image_url image_url: type: object properties: url: type: string description: Either a URL of the image or the base64 encoded image data. detail: type: string enum: - low - high - auto description: Specifies the detail level of the image. required: - url cache_control: type: object properties: type: type: string enum: - ephemeral description: >- Create a cache control breakpoint at this content block. Accepts only the value "ephemeral". 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 required: - type - image_url title: Image content part description: An image content part AudioContentPartSchema: type: object properties: type: type: string enum: - input_audio input_audio: type: object properties: data: type: string description: Base64 encoded audio data. format: type: string enum: - mp3 - wav description: >- The format of the encoded audio data. Currently supports `wav` and `mp3`. required: - data - format required: - type - input_audio title: Audio content part description: An audio content part FileContentPartSchema: 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. description: >- File data for the content part. Must contain either file_data or uri, but not both. RefusalPartSchema: type: object properties: type: type: string enum: - refusal description: The type of the content part. Always `refusal`. refusal: type: string description: The refusal message generated by the model. required: - type title: Refusal part description: A message part containing a refusal message. ReasoningPartSchema: type: object properties: type: type: string enum: - reasoning description: The type of the content part. Always `reasoning`. reasoning: type: string description: >- The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking. signature: type: string description: >- Optional cryptographic signature to verify the authenticity and integrity of the reasoning content required: - type - reasoning - signature title: Reasoning Part description: A message part containing reasoning or chain-of-thought content RedactedReasoningPartSchema: type: object properties: type: type: string enum: - redacted_reasoning description: The type of the content part. Always `reasoning`. data: type: string description: >- The encrypted reasoning or thought process behind the response. Used for chain-of-thought or extended thinking. required: - type - data title: Reasoning Part description: A message part containing reasoning or chain-of-thought content PublicIdentity: type: object properties: id: type: string description: Unique identifier for the contact example: contact_01ARZ3NDEKTSV4RRFFQ69G5FAV display_name: type: string description: Display name of the contact example: Jane Doe email: type: string format: email description: Email address of the contact example: jane.doe@example.com metadata: type: array items: type: object additionalProperties: {} description: >- A hash of key/value pairs containing any other data about the contact example: - department: Engineering role: Senior Developer logo_url: type: string description: URL to the contact's avatar or logo example: https://example.com/avatars/jane-doe.jpg tags: type: array items: type: string description: A list of tags associated with the contact example: - hr - engineering required: - id description: >- Information about the identity making the request. If the identity does not exist, it will be created automatically. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````