> ## 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. # Invoke > Invoke a deployment with a given payload ## OpenAPI ````yaml post /v2/deployments/invoke 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/invoke: post: tags: - Deployments summary: Invoke description: Invoke a deployment with a given payload operationId: DeploymentInvoke requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InvokeDeploymentRequest' responses: '200': description: Successful operation content: application/json: schema: type: object properties: id: type: string format: ulid pattern: ^[0-9A-HJKMNP-TV-Z]{26}$ readOnly: true description: >- A unique identifier for the response. Can be used to add metrics to the transaction. created: type: string format: date-time description: >- A timestamp indicating when the object was created. Usually in a standardized format like ISO 8601 object: type: string enum: - chat - completion - image description: Indicates the type of model used to generate the response model: type: string description: The model used to generate the response 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 - contextualai - moonshotai - zai - minimax - xai - alibaba - tensorix - scaleway - hcompany - inceptron - slack - orq description: The provider used to generate the response is_final: type: boolean description: Indicates if the response is the final response integration_id: type: string description: Indicates integration id used to generate the response telemetry: type: object properties: trace_id: type: string description: >- The trace id for the request that generated this response span_id: type: string description: >- The span id for the request that generated this response required: - trace_id - span_id finalized: type: string format: date-time description: >- A timestamp indicating when the object was finalized. Usually in a standardized format like ISO 8601 system_fingerprint: type: - string - 'null' description: Provider backed system fingerprint. retrievals: type: array items: type: object properties: document: type: string description: >- Content of the retrieved chunk from the knowledge base metadata: type: object properties: file_name: type: string description: Name of the file page_number: type: - number - 'null' description: Page number of the chunk file_type: type: string description: Type of the file rerank_score: type: number description: >- Rerank scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45 search_score: type: number description: >- Search scores are normalized to be in the range [0, 1]. Search score is calculated based on `[Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity)` algorithm. Scores close to 1 indicate the document is closer to the query, and scores closer to 0 indicate the document is farther from the query. required: - file_name - page_number - file_type - search_score description: >- Metadata of the retrieved chunk from the knowledge base required: - document - metadata description: >- List of documents retrieved from the knowledge base. This property is only available when the `include_retrievals` flag is set to `true` in the invoke settings. When stream is set to true, the `retrievals` property will be returned in the last streamed chunk where the property `is_final` is set to `true`. provider_response: description: >- Response returned by the model provider. This functionality is only supported when streaming is not used. If streaming is used, the `provider_response` property will be set to `null`. usage: type: - object - 'null' properties: total_tokens: type: number prompt_tokens: type: number completion_tokens: type: number prompt_tokens_details: type: object properties: cached_tokens: type: - number - 'null' completion_tokens_details: type: - object - 'null' properties: reasoning_tokens: type: - number - 'null' description: Usage metrics for the response choices: type: array items: type: object properties: index: type: number message: oneOf: - type: object properties: type: type: string enum: - tool_calls role: type: string enum: - system - developer - assistant - user - exception - tool - prompt - correction - expected_output description: The role of the prompt message content: type: - string - 'null' 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 reasoning: type: string description: Internal thought process of the model reasoning_signature: type: string description: >- The signature holds a cryptographic token which verifies that the thinking block was generated by the model, and is verified when thinking is part of a multiturn conversation. This value should not be modified and should always be sent to the API when the reasoning is redacted. Currently only supported by `Anthropic`. redacted_reasoning: type: string description: >- Occasionally the model's internal reasoning will be flagged by the safety systems of the provider. When this occurs, the provider will encrypt the reasoning. These redacted reasoning is decrypted when passed back to the API, allowing the model to continue its response without losing context. required: - type - role - tool_calls - type: object properties: type: type: string enum: - content role: type: string enum: - system - developer - assistant - user - exception - tool - prompt - correction - expected_output description: The role of the prompt message content: type: - string - 'null' reasoning: type: string description: Internal thought process of the model reasoning_signature: type: string description: >- The signature holds a cryptographic token which verifies that the thinking block was generated by the model, and is verified when thinking is part of a multiturn conversation. This value should not be modified and should always be sent to the API when the reasoning is redacted. Currently only supported by `Anthropic`. redacted_reasoning: type: string description: >- Occasionally the model's internal reasoning will be flagged by the safety systems of the provider. When this occurs, the provider will encrypt the reasoning. These redacted reasoning is decrypted when passed back to the API, allowing the model to continue its response without losing context. required: - type - role - content - type: object properties: type: type: string enum: - image role: type: string enum: - system - developer - assistant - user - exception - tool - prompt - correction - expected_output description: The role of the prompt message url: type: string required: - type - role - url finish_reason: type: - string - 'null' required: - index - message description: A list of choices generated by the model required: - id - created - object - model - provider - is_final - telemetry - choices '204': description: No content - successful operation components: schemas: InvokeDeploymentRequest: type: object properties: key: type: string description: The deployment key to invoke stream: type: boolean default: false description: >- If set, partial message content will be sent. Tokens will be sent as data-only `server-sent events` as they become available, with the stream terminated by a `data: [DONE]` message. 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 description: The deployment request payload 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 ````