info: title: "orq.ai API" version: "2.0" description: "orq.ai API documentation" security: - ApiKey: [] servers: - url: https://my.orq.ai openapi: "3.1.0" x-speakeasy-timeout: 600000 externalDocs: url: "https://docs.orq.ai" description: "orq.ai Documentation" components: securitySchemes: ApiKey: type: "http" scheme: "bearer" bearerFormat: "JWT" schemas: EvaluatorResponseLlm: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" type: type: "string" enum: - "llm_eval" repetitions: type: - "integer" - "null" minimum: 1 maximum: 3 prompt: type: "string" categories: type: - "array" - "null" items: type: "string" categorical_labels: type: - "array" - "null" items: type: "object" properties: value: type: "string" minLength: 1 description: type: "string" required: - "value" dataset_id: type: - "string" - "null" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" mode: type: "string" enum: - "single" - "jury" model: type: "string" jury: type: "object" properties: judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" minItems: 2 replacement_judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" default: [] min_successful_judges: type: "integer" minimum: 2 default: 2 tie_value: type: "string" enum: - "Tie" default: "Tie" required: - "judges" required: - "_id" - "description" - "type" - "prompt" - "key" - "mode" title: "LLM" EvaluatorResponseJsonSchema: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" type: type: "string" enum: - "json_schema" schema: type: "string" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "_id" - "description" - "type" - "schema" - "key" title: "JSON" EvaluatorResponseHttp: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" type: type: "string" enum: - "http_eval" url: type: "string" method: type: "string" enum: - "GET" - "POST" headers: type: "object" additionalProperties: type: "string" payload: type: "object" additionalProperties: {} key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "_id" - "description" - "type" - "url" - "method" - "headers" - "payload" - "key" title: "HTTP" EvaluatorResponsePython: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" code: type: "string" type: type: "string" enum: - "python_eval" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "_id" - "description" - "code" - "type" - "key" title: "Python" EvaluatorResponseFunction: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" type: type: "string" enum: - "function_eval" function_params: oneOf: - type: "object" properties: type: type: "string" enum: - "contains" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "contains_none" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_all" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_any" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_email" required: - "type" - type: "object" properties: type: type: "string" enum: - "contains_url" required: - "type" - type: "object" properties: type: type: "string" enum: - "contains_valid_link" required: - "type" - type: "object" properties: type: type: "string" enum: - "start_with" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "ends_with" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "exact_match" required: - "type" - type: "object" properties: type: type: "string" enum: - "length_less_than" value: type: "number" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "length_between" min: type: "number" max: type: "number" required: - "type" - "min" - "max" - type: "object" properties: type: type: "string" enum: - "length_greater_than" value: type: "number" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "one_line" required: - "type" - type: "object" properties: type: type: "string" enum: - "regex" pattern: type: "string" required: - "type" - "pattern" - type: "object" properties: type: type: "string" enum: - "is_valid_json" required: - "type" - type: "object" properties: type: type: "string" enum: - "moderations_openai" required: - "type" - type: "object" properties: type: type: "string" enum: - "moderations_google" required: - "type" - type: "object" properties: type: type: "string" enum: - "bert_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "bleu_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "rouge_n" required: - "type" - type: "object" properties: type: type: "string" enum: - "meteor_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "cosine_similarity" required: - "type" - type: "object" properties: type: type: "string" enum: - "levenshtein_distance" required: - "type" - type: "object" properties: type: type: "string" enum: - "keywords_match" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "most_repeated_words" required: - "type" - type: "object" properties: type: type: "string" enum: - "flesch_reading_ease" required: - "type" - type: "object" properties: type: type: "string" enum: - "gse_english_level" required: - "type" - type: "object" properties: type: type: "string" enum: - "words_count" required: - "type" - type: "object" properties: type: type: "string" enum: - "sentences_count" required: - "type" - type: "object" properties: type: type: "string" enum: - "lexical_repetition" required: - "type" - type: "object" properties: type: type: "string" enum: - "grammar_diversity" required: - "type" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "_id" - "description" - "type" - "function_params" - "key" title: "Function" EvaluatorResponseRagas: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" type: type: "string" enum: - "ragas" ragas_metric: type: "string" enum: - "context_precision" - "context_recall" - "context_entities_recall" - "harmfulness" - "maliciousness" - "coherence" - "correctness" - "conciseness" - "response_relevancy" - "faithfulness" - "summarization" - "noise_sensitivity" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" model: type: "string" required: - "_id" - "description" - "type" - "ragas_metric" - "key" - "model" title: "Ragas" EvaluatorResponseTypescript: type: "object" properties: _id: type: "string" description: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" updated_by_id: type: - "string" - "null" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" code: type: "string" type: type: "string" enum: - "typescript_eval" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "_id" - "description" - "code" - "type" - "key" title: "Typescript" EvaluatorVariables: type: "object" additionalProperties: $ref: "#/components/schemas/EvaluatorVariableValue" description: "Template variables for evaluator prompt substitution. Request values override evaluator defaults, including for nested arrays and objects." example: locale: "en" tags: - "alpha" - "omega" profile: tier: "gold" active: true EvaluatorVariableValue: type: - "string" - "number" - "boolean" - "null" - "array" - "object" items: $ref: "#/components/schemas/EvaluatorVariableValue" additionalProperties: $ref: "#/components/schemas/EvaluatorVariableValue" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." HonoApiError: type: "object" properties: code: type: "string" description: "HTTP status code" message: type: "string" description: "Error message" required: - "message" ThinkingConfigDisabledSchema: type: "object" properties: type: type: "string" enum: - "disabled" description: "Disables the thinking mode capability" required: - "type" title: "Thinking config disabled" description: "Disables the thinking mode capability" ThinkingConfigEnabledSchema: type: "object" properties: type: type: "string" enum: - "enabled" description: "Enables or disables the thinking mode capability" budget_tokens: type: "number" description: "Determines how many tokens the model can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`." thinking_level: type: "string" enum: - "minimal" - "low" - "medium" - "high" description: "The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored." required: - "type" - "budget_tokens" title: "Thinking config enabled" description: "Enables the thinking mode capability" ThinkingConfigAdaptiveSchema: type: "object" properties: type: type: "string" enum: - "adaptive" description: "Lets the model dynamically determine when and how much to use extended thinking based on the complexity of each request. Supported on Claude Opus 4.6 and Sonnet 4.6." required: - "type" title: "Thinking config adaptive" description: "Enables adaptive thinking mode where the model dynamically determines thinking depth" PIIRedactionPluginAuto: type: "object" properties: id: type: "string" enum: - "pii_redaction" description: "Plugin discriminator. Must be `pii_redaction`." on_failure: type: "string" enum: - "block" - "passthrough" description: "Behavior when redaction is unavailable. `block` (default) fails the request; `passthrough` sends the original text." threshold: type: "number" minimum: 0 maximum: 1 description: "Detector confidence cutoff in [0,1]." entities: type: "array" items: type: "string" enum: - "AGE" - "API_KEY" - "BANK_ROUTING" - "BIC" - "BIOMETRIC_ID" - "BLOOD_TYPE" - "BSN" - "CREDIT_CARD" - "CRYPTO" - "DATE_TIME" - "DEVICE_ID" - "EDUCATION_LEVEL" - "EMAIL_ADDRESS" - "EMPLOYMENT_STATUS" - "GENDER" - "HEALTH_PLAN_ID" - "HTTP_COOKIE" - "IBAN_CODE" - "ID" - "ID_CARD" - "IMEI" - "IP_ADDRESS" - "JOBTITLE" - "JWT" - "KVK_NUMBER" - "LANGUAGE" - "LICENSE_NUMBER" - "LICENSE_PLATE" - "LOCATION" - "MAC_ADDRESS" - "MEDICAL_LICENSE" - "MEDICAL_RECORD" - "NRP" - "ORGANIZATION" - "PASSPORT" - "PASSWORD" - "PERSON" - "PHONE_NUMBER" - "PIN" - "POLITICAL_VIEW" - "RACE_ETHNICITY" - "RELIGIOUS_BELIEF" - "SEXUALITY" - "TAX_ID" - "TITLE" - "UK_NHS" - "URL" - "US_BANK_NUMBER" - "US_DRIVER_LICENSE" - "US_ITIN" - "US_PASSPORT" - "US_SSN" - "UUID" - "VEHICLE_ID" description: "Entity types to redact when no detector language is configured. Omit to redact every detected type." required: - "id" additionalProperties: false title: "PII redaction plugin (automatic language)" PIIRedactionPluginEn: type: "object" properties: id: type: "string" enum: - "pii_redaction" description: "Plugin discriminator. Must be `pii_redaction`." on_failure: type: "string" enum: - "block" - "passthrough" description: "Behavior when redaction is unavailable. `block` (default) fails the request; `passthrough` sends the original text." threshold: type: "number" minimum: 0 maximum: 1 description: "Detector confidence cutoff in [0,1]." language: type: "string" enum: - "en" description: "Detector language." entities: type: "array" items: type: "string" enum: - "AGE" - "API_KEY" - "BANK_ROUTING" - "BIC" - "BIOMETRIC_ID" - "BLOOD_TYPE" - "BSN" - "CREDIT_CARD" - "CRYPTO" - "DATE_TIME" - "DEVICE_ID" - "EDUCATION_LEVEL" - "EMAIL_ADDRESS" - "EMPLOYMENT_STATUS" - "GENDER" - "HEALTH_PLAN_ID" - "HTTP_COOKIE" - "IBAN_CODE" - "ID" - "ID_CARD" - "IMEI" - "IP_ADDRESS" - "JOBTITLE" - "JWT" - "KVK_NUMBER" - "LANGUAGE" - "LICENSE_NUMBER" - "LICENSE_PLATE" - "LOCATION" - "MAC_ADDRESS" - "MEDICAL_LICENSE" - "MEDICAL_RECORD" - "NRP" - "ORGANIZATION" - "PASSPORT" - "PASSWORD" - "PERSON" - "PHONE_NUMBER" - "PIN" - "POLITICAL_VIEW" - "RACE_ETHNICITY" - "RELIGIOUS_BELIEF" - "SEXUALITY" - "TAX_ID" - "TITLE" - "UK_NHS" - "URL" - "US_BANK_NUMBER" - "US_DRIVER_LICENSE" - "US_ITIN" - "US_PASSPORT" - "US_SSN" - "UUID" - "VEHICLE_ID" description: "English entity types to redact. Omit to redact every type detected for the language." required: - "id" - "language" title: "PII redaction plugin (English)" PIIRedactionPluginNl: type: "object" properties: id: type: "string" enum: - "pii_redaction" description: "Plugin discriminator. Must be `pii_redaction`." on_failure: type: "string" enum: - "block" - "passthrough" description: "Behavior when redaction is unavailable. `block` (default) fails the request; `passthrough` sends the original text." threshold: type: "number" minimum: 0 maximum: 1 description: "Detector confidence cutoff in [0,1]." language: type: "string" enum: - "nl" description: "Detector language." entities: type: "array" items: type: "string" enum: - "AGE" - "API_KEY" - "BANK_ROUTING" - "BIC" - "BIOMETRIC_ID" - "BLOOD_TYPE" - "BSN" - "CREDIT_CARD" - "CRYPTO" - "DATE_TIME" - "DEVICE_ID" - "EDUCATION_LEVEL" - "EMAIL_ADDRESS" - "EMPLOYMENT_STATUS" - "GENDER" - "HEALTH_PLAN_ID" - "HTTP_COOKIE" - "IBAN_CODE" - "ID" - "ID_CARD" - "IMEI" - "IP_ADDRESS" - "KVK_NUMBER" - "LANGUAGE" - "LICENSE_NUMBER" - "LICENSE_PLATE" - "LOCATION" - "MAC_ADDRESS" - "MEDICAL_RECORD" - "NRP" - "ORGANIZATION" - "PASSPORT" - "PASSWORD" - "PERSON" - "PHONE_NUMBER" - "PIN" - "POLITICAL_VIEW" - "RACE_ETHNICITY" - "RELIGIOUS_BELIEF" - "SEXUALITY" - "TAX_ID" - "TITLE" - "URL" - "US_DRIVER_LICENSE" - "US_SSN" - "VEHICLE_ID" description: "Dutch entity types to redact. Omit to redact every type detected for the language." required: - "id" - "language" title: "PII redaction plugin (Dutch)" ResponseHealingPlugin: type: "object" properties: id: type: "string" enum: - "response_healing" description: "Plugin discriminator. Must be `response_healing`." required: - "id" additionalProperties: false title: "Response healing plugin" AgentToolInputCRUD: anyOf: - type: "object" properties: type: type: "string" enum: - "google_search" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Google search tool" description: "Performs Google searches to retrieve web content" - type: "object" properties: type: type: "string" enum: - "web_scraper" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Web scraper tool" description: "Scrapes and extracts content from web pages" - type: "object" properties: type: type: "string" enum: - "call_sub_agent" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Call sub agent tool" description: "Delegates tasks to specialized sub-agents" - type: "object" properties: type: type: "string" enum: - "retrieve_agents" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve agents tool" description: "Retrieves available agents in the system" - type: "object" properties: type: type: "string" enum: - "query_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query memory store tool" description: "Queries agent memory stores for context" - type: "object" properties: type: type: "string" enum: - "write_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Write memory store tool" description: "Writes information to agent memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_memory_stores" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve memory stores tool" description: "Lists available memory stores" - type: "object" properties: type: type: "string" enum: - "delete_memory_document" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Delete memory document tool" description: "Deletes documents from memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_knowledge_bases" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve knowledge bases tool" description: "Lists available knowledge bases" - type: "object" properties: type: type: "string" enum: - "query_knowledge_base" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query knowledge base tool" description: "Queries knowledge bases for information" - type: "object" properties: type: type: "string" enum: - "current_date" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Current date tool" description: "Returns the current date and time" - type: "object" properties: type: type: "string" enum: - "advisor" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Advisor tool" description: "Consult a secondary model for advice on the current task" - type: "object" properties: type: type: "string" enum: - "sidekick" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Sidekick tool" description: "Delegate a subtask to a secondary model for execution" - type: "object" properties: type: type: "string" enum: - "code_interpreter" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Code interpreter tool" description: "Executes model-written Python code. Uses provider-native code execution when the model supports it, otherwise a secure orq-managed sandbox." - $ref: "#/components/schemas/HttpToolInput" - $ref: "#/components/schemas/CodeToolInput" - $ref: "#/components/schemas/FunctionToolInput" - $ref: "#/components/schemas/JsonSchemaToolInput" - $ref: "#/components/schemas/McpToolInput" - $ref: "#/components/schemas/ProviderToolInput" description: "Tool configuration for agent create/update operations. Built-in tools only require a type, while custom tools (HTTP, Code, Function, JSON Schema, MCP) must reference pre-created tools by key or id. Provider-prefixed tools (e.g., openai:web_search) are passed through to the provider." title: "Agent Tool Input (CRUD)" discriminator: propertyName: "type" mapping: http: "#/components/schemas/HttpToolInput" code: "#/components/schemas/CodeToolInput" function: "#/components/schemas/FunctionToolInput" json_schema: "#/components/schemas/JsonSchemaToolInput" mcp: "#/components/schemas/McpToolInput" HttpToolInput: type: "object" properties: type: type: "string" enum: - "http" default: "http" description: "HTTP tool type" key: type: "string" description: "The key of the pre-created HTTP tool" id: type: "string" description: "The ID of the pre-created HTTP tool" requires_approval: type: "boolean" default: false description: "Whether this tool requires approval before execution" timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services. Must reference a pre-created HTTP tool by key or id." CodeToolInput: type: "object" properties: type: type: "string" enum: - "code" default: "code" description: "Code execution tool type" key: type: "string" description: "The key of the pre-created code tool" id: type: "string" description: "The ID of the pre-created code tool" requires_approval: type: "boolean" default: false description: "Whether this tool requires approval before execution" timeout: type: "number" minimum: 1 maximum: 120 description: "Tool execution timeout in seconds for this agent (max: 2 minutes, the code sandbox cap). Overrides the timeout configured on the tool definition." title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment. Must reference a pre-created code tool by key or id." FunctionToolInput: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "Function tool type" key: type: "string" description: "The key of the pre-created function tool" id: type: "string" description: "The ID of the pre-created function tool" requires_approval: type: "boolean" default: false description: "Whether this tool requires approval before execution" title: "Function Tool" description: "Calls custom function tools defined in the agent configuration. Must reference a pre-created function tool by key or id." JsonSchemaToolInput: type: "object" properties: type: type: "string" enum: - "json_schema" default: "json_schema" description: "JSON Schema tool type" key: type: "string" description: "The key of the pre-created JSON Schema tool" id: type: "string" description: "The ID of the pre-created JSON Schema tool" requires_approval: type: "boolean" default: false description: "Whether this tool requires approval before execution" title: "JSON Schema Tool" description: "Enforces structured output format using JSON Schema. Must reference a pre-created JSON Schema tool by key or id." McpToolInput: type: "object" properties: type: type: "string" enum: - "mcp" default: "mcp" description: "MCP tool type" key: type: "string" description: "The key of the parent MCP tool" id: type: "string" description: "The ID of the parent MCP tool" tool_id: type: "string" description: "The ID of the specific nested tool within the MCP server" requires_approval: type: "boolean" default: false description: "Whether this tool requires approval before execution" required: - "tool_id" title: "MCP Tool" description: "Executes tools from Model Context Protocol (MCP) servers. Specify the parent MCP tool using \"key\" or \"id\", and the specific nested tool using \"tool_id\"." example: type: "mcp" id: "01KA84ND5J0SWQMA2Q8HY5WZZZ" tool_id: "01KXYZ123456789" requires_approval: false ProviderToolInput: type: "object" properties: type: type: "string" pattern: "^[a-z][a-z0-9_-]*:.+$" description: "Provider-prefixed tool type" key: type: "string" description: "The key of a pre-created tool" id: type: "string" description: "The ID of a pre-created tool" timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Provider Built-in Tool" description: "Provider-specific built-in tools that are passed through to the provider. Must be prefixed with the provider name (e.g., openai:web_search, anthropic:web_search_20250305, google:google_search)." example: type: "openai:web_search" CreateAgentResponse: type: "object" properties: _id: type: "string" description: "The unique response ID" task_id: type: "string" description: "The agent execution task ID" output: type: "array" items: $ref: "#/components/schemas/AgentResponseMessage" description: "Array of messages from the agent execution" created_at: type: "string" description: "ISO timestamp of response creation" model: type: "string" description: "Model used in provider/model format" usage: type: - "object" - "null" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Token usage from the agent execution" finish_reason: type: "string" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - "max_iterations" - "max_time" description: "The reason why the agent stopped generating" pending_tool_calls: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" enum: - "function" function: type: "object" properties: name: type: "string" arguments: type: "string" required: - "id" - "type" - "function" description: "Tool calls awaiting user response (when finish_reason is function_call)" telemetry: $ref: "#/components/schemas/Telemetry" required: - "_id" - "task_id" - "output" - "created_at" - "model" title: "Create Agent Response" description: "Response type from the create-response endpoint." AgentResponseMessage: type: "object" properties: messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" metadata: type: "object" additionalProperties: {} required: - "messageId" - "role" - "parts" title: "Agent Response Message" description: "Response message from an agent execution." TextPart: type: "object" properties: kind: type: "string" enum: - "text" text: type: "string" required: - "kind" - "text" title: "Text Part" description: "A text content part containing plain text or markdown. Used for agent messages, user input, and text-based responses." ErrorPart: type: "object" properties: kind: type: "string" enum: - "error" error: type: "string" code: type: "number" required: - "kind" - "error" title: "Error Part" description: "An error content part containing error information. Used when an error occurs during agent execution." DataPart: type: "object" properties: kind: type: "string" enum: - "data" data: type: "object" additionalProperties: {} metadata: type: "object" additionalProperties: {} required: - "kind" - "data" title: "Data Part" description: "A structured data part containing JSON-serializable key-value pairs. Used for passing structured information between agents and tools." FilePart: type: "object" properties: kind: type: "string" enum: - "file" file: anyOf: - type: "object" properties: bytes: type: "string" minLength: 1 description: "base64 encoded content of the file" mimeType: type: "string" description: "Optional mimeType for the file" name: type: "string" description: "Optional name for the file" required: - "bytes" title: "Binary format" description: "Binary in base64 format. Check in the model's documentation for the supported mime types for the binary format." - type: "object" properties: uri: type: "string" description: "URL for the File content" mimeType: type: "string" description: "Optional mimeType for the file" name: type: "string" description: "Optional name for the file" required: - "uri" title: "File in URI format" description: "File in URI format. Check in the model's documentation for the supported mime types for the URI format" metadata: type: "object" additionalProperties: {} required: - "kind" - "file" title: "File Part" description: "A file content part that can contain either base64-encoded bytes or a URI reference. Used for images, documents, and other binary content in agent communications." ToolCallPart: type: "object" properties: kind: type: "string" enum: - "tool_call" tool_name: type: "string" tool_call_id: type: "string" minLength: 1 arguments: type: "object" additionalProperties: {} thought_signature: type: "string" metadata: type: "object" additionalProperties: {} required: - "kind" - "tool_name" - "tool_call_id" - "arguments" title: "Tool Call Part" description: "A tool invocation request from an agent. Contains the tool name, unique call ID, and arguments for the tool execution." ToolResultPart: type: "object" properties: kind: type: "string" enum: - "tool_result" tool_call_id: type: "string" minLength: 1 result: {} metadata: type: "object" additionalProperties: {} required: - "kind" - "tool_call_id" title: "Tool Result Part" description: "The result of a tool execution. Contains the tool call ID for correlation and the result data from the tool invocation." Telemetry: type: "object" properties: trace_id: type: "string" description: "The root trace ID for the agent execution" span_id: type: "string" description: "The span ID of the agent execution within the trace" required: - "trace_id" - "span_id" title: "Telemetry" description: "Telemetry information for correlating the response with traces" ResponseStreamingEvent: oneOf: - $ref: "#/components/schemas/ResponseStartedEvent" - $ref: "#/components/schemas/ResponseDoneEvent" - $ref: "#/components/schemas/ResponseFailedEvent" - $ref: "#/components/schemas/ToolStartedEvent" - $ref: "#/components/schemas/ToolDoneEvent" - $ref: "#/components/schemas/ToolFailedEvent" - $ref: "#/components/schemas/ToolReviewRequestedEvent" - $ref: "#/components/schemas/ToolReviewDoneEvent" - $ref: "#/components/schemas/PartDeltaEvent" - $ref: "#/components/schemas/PartDoneEvent" discriminator: propertyName: "type" mapping: response.started: "#/components/schemas/ResponseStartedEvent" response.done: "#/components/schemas/ResponseDoneEvent" response.failed: "#/components/schemas/ResponseFailedEvent" tool.started: "#/components/schemas/ToolStartedEvent" tool.done: "#/components/schemas/ToolDoneEvent" tool.failed: "#/components/schemas/ToolFailedEvent" tool.review.requested: "#/components/schemas/ToolReviewRequestedEvent" tool.review.done: "#/components/schemas/ToolReviewDoneEvent" part.delta: "#/components/schemas/PartDeltaEvent" part.done: "#/components/schemas/PartDoneEvent" title: "Response Streaming Event" description: "Union of all possible streaming events. Each event has a type field for discrimination." ResponseStartedEvent: type: "object" properties: type: type: "string" enum: - "response.started" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: responseId: type: "string" description: "Unique identifier for this response" taskId: type: "string" description: "The agent execution task ID. Use responseId for tracking instead." deprecated: true x-deprecation-notice: "This field will be replaced by previous_response_id in a future version. Track the responseId from each response to use for continuations." model: type: "string" description: "The model ID being used for this response in provider/model format" workflowRunId: type: "string" description: "Trace ID for this turn of the conversation (new for each continuation)" userMessageId: type: "string" description: "Server-generated ID for the user message. Use this ID for frontend state consistency." assistantMessageId: type: "string" description: "Server-generated ID for the assistant message. Use this ID for frontend state consistency." telemetry: $ref: "#/components/schemas/Telemetry" required: - "responseId" - "taskId" - "model" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Response Started Event" description: "Emitted when the agent begins processing. Contains identifiers for tracking the response." ResponseDoneEvent: type: "object" properties: type: type: "string" enum: - "response.done" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: finishReason: type: "string" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - "max_iterations" - "max_time" description: "The reason why the agent stopped generating" usage: type: "object" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Token usage statistics for the complete response" pendingToolCalls: type: "array" items: type: "object" properties: id: type: "string" description: "Unique identifier for the tool call" type: type: "string" enum: - "function" function: type: "object" properties: name: type: "string" description: "The name of the function to call" arguments: type: "string" description: "The arguments to pass to the function as JSON string" required: - "id" - "type" - "function" description: "Tool calls awaiting user response (when finishReason is function_call)" telemetry: $ref: "#/components/schemas/Telemetry" required: - "finishReason" required: - "type" - "timestamp" - "data" title: "Response Done Event" description: "Emitted when the agent completes processing. Contains the finish reason and usage statistics." ResponseFailedEvent: type: "object" properties: type: type: "string" enum: - "response.failed" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: error: type: "string" description: "Error message describing what went wrong" code: type: "number" description: "HTTP status code indicating the error type" required: - "error" - "code" required: - "type" - "timestamp" - "data" title: "Response Failed Event" description: "Emitted when an error occurs during agent execution. Contains error details." ToolStartedEvent: type: "object" properties: type: type: "string" enum: - "tool.started" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: toolId: type: "string" description: "Unique identifier for the tool" toolName: type: "string" description: "Display name of the tool" toolCallId: type: "string" description: "Unique identifier for this specific tool call" arguments: type: "object" additionalProperties: {} description: "Arguments passed to the tool" required: - "toolId" - "toolCallId" - "arguments" required: - "type" - "timestamp" - "data" title: "Tool Started Event" description: "Emitted when a tool begins execution. Contains tool details and input arguments." ToolDoneEvent: type: "object" properties: type: type: "string" enum: - "tool.done" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: toolId: type: "string" description: "Unique identifier for the tool in the tool registry" toolCallId: type: "string" description: "Unique identifier matching the tool call that was executed" result: description: "The result returned by the tool" required: - "toolId" - "toolCallId" required: - "type" - "timestamp" - "data" title: "Tool Done Event" description: "Emitted when a tool completes execution successfully. Contains the tool result." ToolFailedEvent: type: "object" properties: type: type: "string" enum: - "tool.failed" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: toolId: type: "string" description: "Unique identifier for the tool in the tool registry" toolCallId: type: "string" description: "Unique identifier matching the tool call that failed" error: type: "string" description: "Error message describing why the tool failed" required: - "toolId" - "toolCallId" - "error" required: - "type" - "timestamp" - "data" title: "Tool Failed Event" description: "Emitted when a tool execution fails. Contains error details." ToolReviewRequestedEvent: type: "object" properties: type: type: "string" enum: - "tool.review.requested" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: toolId: type: "string" description: "Unique identifier for the tool in the tool registry" toolCallId: type: "string" description: "The tool call ID requiring review" toolName: type: "string" description: "Name of the tool requiring approval" arguments: type: "object" additionalProperties: {} description: "Arguments that will be passed to the tool" requiresApproval: type: "boolean" description: "Whether approval is mandatory before execution" required: - "toolId" - "toolCallId" - "arguments" - "requiresApproval" required: - "type" - "timestamp" - "data" title: "Tool Review Requested Event" description: "Emitted when a tool action requires approval before execution. The execution will pause until reviewed." ToolReviewDoneEvent: type: "object" properties: type: type: "string" enum: - "tool.review.done" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: toolId: type: "string" description: "Unique identifier for the tool in the tool registry" toolCallId: type: "string" description: "The tool call ID that was reviewed" review: $ref: "#/components/schemas/ReviewOutcome" required: - "toolId" - "toolCallId" - "review" required: - "type" - "timestamp" - "data" title: "Tool Review Done Event" description: "Emitted after a tool action has been reviewed. Contains the review decision." ReviewOutcome: type: "string" enum: - "approved" - "rejected" title: "Review Outcome" description: "The review decision" PartDeltaEvent: type: "object" properties: type: type: "string" enum: - "part.delta" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: partId: type: "string" description: "Unique identifier for this part. Format: {kind}_{ulid}. Use to correlate with part.done event." example: "text_01hxyz123abc" delta: $ref: "#/components/schemas/PartDelta" required: - "partId" - "delta" required: - "type" - "timestamp" - "data" title: "Part Delta Event" description: "Emitted for each content chunk streamed from the LLM. The delta field contains a discriminated union based on the kind field." PartDelta: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "A message part containing text content" - $ref: "#/components/schemas/ReasoningPart" - allOf: - $ref: "#/components/schemas/FilePart" - description: "A message part containing file content, either embedded or referenced" - allOf: - $ref: "#/components/schemas/DataPart" - description: "A message part containing arbitrary structured data as key-value pairs" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" reasoning: "#/components/schemas/ReasoningPart" file: "#/components/schemas/FilePart" data: "#/components/schemas/DataPart" description: "The content chunk being streamed. Discriminated by kind field (text or reasoning)." ReasoningPart: allOf: - $ref: "#/components/schemas/BasePart" - type: "object" properties: _id: type: "string" default: "reasoning_01kzeae6bmbwwpsr9k51yh781t" description: "Unique identifier for the part. Format: reasoning_{ulid} (e.g., reasoning_01hxyz...)" example: "reasoning_01hxyz123abc" kind: type: "string" enum: - "reasoning" description: "Type discriminator indicating this is a reasoning part" example: "reasoning" reasoning: type: "string" description: "The reasoning or thought process behind the response. Used for chain-of-thought or extended thinking." example: "Let me analyze this step by step..." signature: type: "string" description: "Optional cryptographic signature to verify the authenticity and integrity of the reasoning content" example: "sha256:a1b2c3d4e5f6..." required: - "kind" - "reasoning" title: "Reasoning Part" description: "A message part containing reasoning or chain-of-thought content" BasePart: type: "object" properties: _id: type: "string" description: "Unique identifier for the part. Format: {kind}_{ulid} (e.g., text_01hxyz...)" example: "text_01hxyz123abc" metadata: type: "object" additionalProperties: {} description: "Optional metadata associated with the message part. Can store arbitrary key-value pairs for custom data. Maximum size of 50KB and maximum of 20 keys." example: source: "user_input" timestamp: "2024-01-15T10:30:00Z" required: - "_id" title: "Base Part" description: "Base schema for all message parts" PartDoneEvent: type: "object" properties: type: type: "string" enum: - "part.done" timestamp: type: "string" description: "ISO timestamp of when the event occurred" data: type: "object" properties: partId: type: "string" description: "Unique identifier for this part. Matches the partId from part.delta events." example: "text_01hxyz123abc" part: allOf: - $ref: "#/components/schemas/PartDelta" - description: "The complete part. Discriminated by kind field (text, reasoning, file, data)." required: - "partId" - "part" required: - "type" - "timestamp" - "data" title: "Part Done Event" description: "Emitted when a part has been fully streamed. Contains the complete part with all content." AgentResponseRequest: type: "object" properties: task_id: type: "string" description: "Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue." message: type: "object" properties: messageId: type: "string" description: "Optional A2A message ID in ULID format" role: anyOf: - type: "string" enum: - "user" title: "User message" description: "Message from the end user" - type: "string" enum: - "tool" title: "Tool message" description: "Message containing tool execution results" description: "Message role (user or tool for continuing executions)" parts: type: "array" items: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "Text content part. Use this to send text messages to the agent." - allOf: - $ref: "#/components/schemas/FilePart" - description: "File attachment part. Use this to send files (images, documents, etc.) to the agent for processing." - allOf: - $ref: "#/components/schemas/ToolResultPart" - description: "Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request." - allOf: - $ref: "#/components/schemas/ErrorPart" - description: "Error content part. Generated by the system when an error occurs during agent execution." discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" file: "#/components/schemas/FilePart" tool_result: "#/components/schemas/ToolResultPart" error: "#/components/schemas/ErrorPart" title: "Public Message Part" description: "Message part that can be provided by users. Use \"text\" for regular messages, \"file\" for attachments, or \"tool_result\" when responding to tool call requests." description: "A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts." required: - "role" - "parts" title: "A2A Message" description: "The A2A message to send to the agent (user input or tool results)" variables: type: "object" additionalProperties: {} description: "Optional variables for template replacement in system prompt, instructions, and messages" identity: 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." contact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" memory: type: "object" properties: entity_id: type: "string" description: "An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions." required: - "entity_id" description: "Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions." metadata: type: "object" additionalProperties: {} description: "Optional metadata for the agent invocation as key-value pairs that will be included in traces" engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "Override template engine for this invocation. If not provided, uses the agent default." configuration: type: "object" properties: blocking: type: "boolean" default: false description: "Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status." description: "Configuration options for the agent invocation" background: type: "boolean" default: false description: "If true, returns immediately without waiting for completion. If false (default), waits until the agent becomes inactive or errors." stream: type: "boolean" default: false description: "If true, returns Server-Sent Events (SSE) streaming response with real-time events. If false (default), returns standard JSON response." conversation: type: "object" properties: _id: type: "string" minLength: 1 description: "Unique ULID identifier for the conversation, prefixed with \"conv_\". Used to link agent executions to a specific conversation thread." required: - "_id" description: "Conversation context for chat studio integration" required: - "message" title: "Agent Response Request" description: "Request body for creating an agent response. Extends A2AInvokeRequest with response options. Matches POST /v2/agents/{key}/responses" GetAgentResponse: allOf: - $ref: "#/components/schemas/CreateAgentResponse" - type: "object" properties: status: type: "string" enum: - "in_progress" - "completed" - "failed" description: "Current status of the agent response" error: type: "string" description: "Error message when status is failed" required: - "status" title: "Get Agent Response" description: "Response type from the get-response endpoint. Includes a status field indicating the current state of the agent execution." ExtendedMessage: type: "object" properties: kind: type: "string" enum: - "message" messageId: type: "string" description: "Unique identifier for the message" role: type: "string" enum: - "user" - "agent" - "tool" - "system" title: "Extended Message Role" description: "Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts)." parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" description: "Array of message parts (text, file, tool_call, tool_result)" taskId: type: "string" description: "Associated task ID if applicable" contextId: type: "string" description: "Correlation ID for execution tracking" metadata: type: "object" additionalProperties: {} description: "Additional message metadata" required: - "kind" - "messageId" - "role" - "parts" title: "Extended A2A Message" description: "Extended Agent-to-Agent protocol message with support for tool calls and tool results. Extends the base A2A message format with Orquesta-specific features." AgentExecutionStartedStreamingEvent: type: "object" properties: type: type: "string" enum: - "agents.execution_started" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: agent_task_id: type: "string" description: "Agent execution task ID (ULID)" workspace_id: type: "string" description: "Workspace ID" trace_id: type: "string" description: "Trace ID for the workflow run" required: - "agent_task_id" - "workspace_id" - "trace_id" required: - "type" - "timestamp" - "data" title: "Agent Execution Started Event" description: "Initial event emitted when an agent stream begins. Contains the task ID for tracking, workspace context, and trace ID for observability." AgentStartedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.started" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: workflowRunId: type: "string" integration_id: type: "string" inputMessage: type: "object" properties: messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" description: "Extended A2A message role" parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" metadata: type: "object" additionalProperties: {} required: - "role" - "parts" modelId: type: "string" instructions: type: "string" system_prompt: type: "string" settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: 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" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" default: [] 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" default: max_execution_time: 600 max_iterations: 100 max_cost: 0 tool_approval_required: "respect_tool" tools: [] agent_manifest_id: type: "string" agent_key: type: "string" agent_description: type: - "string" - "null" agent_source: type: - "string" - "null" enum: - "internal" - "external" - "experiment" - null variables: type: "object" additionalProperties: {} tool_execution_id: type: "string" is_continuation: type: "boolean" stream: type: "boolean" responseId: type: "string" required: - "workflowRunId" - "inputMessage" - "modelId" - "instructions" - "system_prompt" - "agent_manifest_id" - "agent_key" required: - "type" - "timestamp" - "data" title: "Agent Started Event" description: "Emitted when the agent begins processing. Contains configuration details including the model, instructions, system prompt, and input message." AgentThoughtStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.thought" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: agent_id: type: "string" message_difference: type: "object" additionalProperties: type: "object" properties: messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" metadata: type: "object" additionalProperties: {} agent_id: type: "string" agent_execution_id: type: "string" workspace_id: type: "string" required: - "messageId" - "role" - "parts" - "agent_id" - "agent_execution_id" - "workspace_id" choice: type: "object" properties: finish_reason: type: - "string" - "null" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - null description: "The reason the model stopped generating tokens." index: type: "number" default: 0 description: "The index of the choice in the list of choices." message: type: "object" properties: content: type: - "string" - "null" refusal: type: - "string" - "null" tool_calls: type: "array" items: type: "object" properties: index: type: "number" id: type: "string" type: type: "string" enum: - "function" 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." 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." role: type: "string" enum: - "assistant" reasoning: type: - "string" - "null" description: "Internal thought process of the model" reasoning_signature: type: - "string" - "null" 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." audio: type: - "object" - "null" properties: id: type: "string" expires_at: type: "integer" data: type: "string" transcript: type: "string" required: - "id" - "expires_at" - "data" - "transcript" description: "If the audio output modality is requested, this object contains data about the audio response from the model." description: "A chat completion message generated by the model." logprobs: type: - "object" - "null" properties: content: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message content tokens with log probability information." refusal: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message refusal tokens with log probability information." required: - "content" - "refusal" description: "Log probability information for the choice." required: - "finish_reason" - "message" choiceIndex: type: "number" iteration: type: "number" accumulated_execution_time: type: "number" responseId: type: "string" usage: type: "object" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Usage statistics for the completion request." required: - "agent_id" - "message_difference" - "iteration" - "accumulated_execution_time" required: - "type" - "timestamp" - "data" title: "Agent Thought Event" description: "Emitted during agent reasoning. Contains the incremental message changes, model choices, iteration count, and token usage for this processing step." AgentInactiveStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.inactive" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: last_message: type: "string" last_message_full: type: "object" properties: messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" description: "Extended A2A message role" parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" metadata: type: "object" additionalProperties: {} required: - "role" - "parts" description: "Full last message in A2A format (for backwards compatibility)" finish_reason: type: "string" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - "max_iterations" - "max_time" description: "The reason why the agent execution became inactive" pending_tool_calls: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" enum: - "function" function: type: "object" properties: name: type: "string" arguments: type: "string" required: - "id" - "type" - "function" description: "Tool calls that are pending user response (for function_call finish reason)" usage: type: "object" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." time_to_first_token: type: "number" description: "Token usage from the last agent message" billing: type: "object" properties: total_cost: type: "number" minimum: 0 input_cost: type: "number" minimum: 0 output_cost: type: "number" minimum: 0 billable: type: "boolean" integration_id: type: - "string" - "null" required: - "total_cost" - "input_cost" - "output_cost" - "billable" - "integration_id" description: "Billing information for the agent execution" workflowRunId: type: "string" responseId: type: "string" description: "ID of the response tracking this execution" required: - "last_message" - "finish_reason" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Agent Inactive Event" description: "Emitted when the agent completes processing or pauses for input. Contains the final message, finish reason (stop, tool_calls, max_iterations, etc.), and any pending tool calls awaiting user response." AgentErroredStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.errored" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: error: type: "string" code: type: "number" responseId: type: "string" description: "ID of the response tracking this execution" workflowRunId: type: "string" required: - "error" - "code" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Agent Errored Event" description: "Emitted when an error occurs during agent execution. Contains the error message and HTTP status code indicating the failure type." ActionReviewRequestedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.action_review_requested" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: agent_id: type: "string" action_id: type: "string" requires_approval: type: "boolean" tool: type: "object" properties: id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" input: type: "object" additionalProperties: {} agent_tool_call_id: type: "string" responseId: type: "string" required: - "agent_id" - "action_id" - "requires_approval" - "tool" - "input" - "agent_tool_call_id" required: - "type" - "timestamp" - "data" title: "Action Review Requested Event" description: "Emitted when a tool action requires approval before execution. Contains the tool details, input arguments, and whether approval is mandatory." ActionReviewedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.action_reviewed" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: agent_id: type: "string" action_id: type: "string" agent_tool_call_id: type: "string" review: type: "string" enum: - "approved" - "rejected" mock_output: type: "object" additionalProperties: {} review_source: type: "string" reviewed_by_id: type: "string" workflowRunId: type: "string" required: - "agent_id" - "action_id" - "agent_tool_call_id" - "review" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Action Reviewed Event" description: "Emitted after a tool action has been reviewed. Contains the review decision (approved/rejected), optional mock output for rejected actions, and reviewer information." ExecutionReviewRequiredStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.execution_review_required" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: {} required: - "type" - "timestamp" - "data" title: "Execution Review Required Event" description: "Emitted when the entire agent execution requires human review before proceeding. The execution will pause until reviewed." ExecutionReviewedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.execution_reviewed" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: {} required: - "type" - "timestamp" - "data" title: "Execution Reviewed Event" description: "Emitted after the agent execution has been reviewed. The execution will resume processing after this event." ExecutionNamedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.execution_named" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: name: type: "string" agent_manifest_id: type: "string" required: - "name" - "agent_manifest_id" required: - "type" - "timestamp" - "data" title: "Execution Named Event" description: "Emitted when the agent execution is assigned a human-readable name, typically generated based on the conversation content." AgentHandedOffStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.handed_off" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: agent_id: type: "string" input: type: "string" required: - "agent_id" - "input" required: - "type" - "timestamp" - "data" title: "Agent Handed Off Event" description: "Emitted when control is transferred to a sub-agent. Contains the target agent ID and the input message for the handoff." AgentMessageCreatedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.agents.message-created" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: workflowRunId: type: "string" spanId: type: "string" parentId: type: "string" message: type: "array" items: type: "object" properties: messageId: type: "string" role: type: "string" enum: - "user" - "tool" parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" metadata: type: "object" additionalProperties: {} required: - "role" - "parts" required: - "workflowRunId" - "spanId" - "parentId" - "message" required: - "type" - "timestamp" - "data" title: "Agent Message Created Event" description: "Emitted when a new message is added to the conversation. Contains the message content, workflow run ID, and span context for tracing." ToolExecutionStartedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.workflow_events.tool_execution_started" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: tool_id: type: "string" tool_key: type: "string" tool_display_name: type: "string" tool_description: type: - "string" - "null" action_type: type: "string" tool_arguments: type: "object" additionalProperties: {} tool_execution_context: type: "object" properties: action_id: type: "string" agent_tool_call_id: type: "string" workspace_id: type: "string" agent_manifest_id: type: "string" agent_execution_id: type: "string" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" description: "Orquesta product" memory: type: "object" properties: entity_id: type: "string" required: - "entity_id" parent_id: type: "string" variables: type: "object" additionalProperties: {} secret_keys: type: "array" items: type: "string" required: - "action_id" - "agent_tool_call_id" - "workspace_id" - "agent_manifest_id" - "agent_execution_id" - "product" responseId: type: "string" workflowRunId: type: "string" stream: type: "boolean" required: - "tool_id" - "action_type" - "tool_arguments" - "tool_execution_context" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Tool Execution Started Event" description: "Emitted when a tool begins execution. Contains the tool ID, name, action type, input arguments, and execution context." ToolExecutionFinishedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.workflow_events.tool_execution_finished" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: result: {} action_type: type: "string" tool_execution_context: type: "object" properties: action_id: type: "string" agent_tool_call_id: type: "string" workspace_id: type: "string" agent_manifest_id: type: "string" agent_execution_id: type: "string" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" description: "Orquesta product" memory: type: "object" properties: entity_id: type: "string" required: - "entity_id" parent_id: type: "string" variables: type: "object" additionalProperties: {} secret_keys: type: "array" items: type: "string" required: - "action_id" - "agent_tool_call_id" - "workspace_id" - "agent_manifest_id" - "agent_execution_id" - "product" responseId: type: "string" workflowRunId: type: "string" stream: type: "boolean" required: - "action_type" - "tool_execution_context" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Tool Execution Finished Event" description: "Emitted when a tool completes execution successfully. Contains the result data, action type, and execution context." ToolExecutionFailedStreamingEvent: type: "object" properties: type: type: "string" enum: - "event.workflow_events.tool_execution_failed" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: error: type: "object" properties: message: type: "string" stack: type: "string" required: - "message" action_type: type: "string" tool_execution_context: type: "object" properties: action_id: type: "string" agent_tool_call_id: type: "string" workspace_id: type: "string" agent_manifest_id: type: "string" agent_execution_id: type: "string" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" description: "Orquesta product" memory: type: "object" properties: entity_id: type: "string" required: - "entity_id" parent_id: type: "string" variables: type: "object" additionalProperties: {} secret_keys: type: "array" items: type: "string" required: - "action_id" - "agent_tool_call_id" - "workspace_id" - "agent_manifest_id" - "agent_execution_id" - "product" responseId: type: "string" workflowRunId: type: "string" stream: type: "boolean" required: - "error" - "action_type" - "tool_execution_context" - "workflowRunId" required: - "type" - "timestamp" - "data" title: "Tool Execution Failed Event" description: "Emitted when a tool execution fails. Contains the error details, action type, and execution context." TimeoutStreamingEvent: type: "object" properties: type: type: "string" enum: - "agents.timeout" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: message: type: "string" required: - "message" required: - "type" - "timestamp" - "data" title: "Timeout Event" description: "Emitted when the agent stream exceeds the configured timeout duration. Contains a message describing the timeout condition." ErrorStreamingEvent: type: "object" properties: type: type: "string" enum: - "agents.error" timestamp: type: "string" description: "ISO timestamp of the event" data: type: "object" properties: error: type: "string" code: type: "string" required: - "error" - "code" required: - "type" - "timestamp" - "data" title: "Error Event" description: "Emitted when a streaming error occurs outside of normal agent execution. Contains the error message and error code for debugging." PublicContact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true DetectRequest: type: "object" properties: text: type: "string" description: "Text to analyse." language: type: "string" description: "BCP-47 language code. Unset means auto-detect." threshold: type: "number" description: "Global minimum recognizer score (0.0-1.0). Unset uses the provider default." format: "double" include_entities: type: "boolean" description: "When true, the response includes a per-type entity breakdown." description: "The workspace is resolved from the API key, never sent in the body." DetectResponse: type: "object" properties: has_pii: type: "boolean" entities: type: "object" additionalProperties: type: "integer" format: "int32" description: "Per-entity-type counts. Populated only when include_entities was set." RedactRequest: type: "object" properties: text: type: "string" language: type: "string" threshold: type: "number" format: "double" RedactResponse: type: "object" properties: redacted_text: type: "string" mappings: type: "object" additionalProperties: type: "string" description: "Maps each placeholder (e.g. \"\") to the original value it replaced." RestoreRequest: type: "object" properties: redacted_text: type: "string" mappings: type: "object" additionalProperties: type: "string" description: "Placeholder-to-original mapping produced by Redact." RestoreResponse: type: "object" properties: original_text: type: "string" AutoRouterConfig: additionalProperties: false properties: economical_model: type: "string" id: type: "string" models: items: type: "string" type: - "array" - "null" profile: type: "string" strong_model: type: "string" v2: $ref: "#/components/schemas/AutoRouterV2Config" version: type: "string" type: "object" AutoRouterV2Config: additionalProperties: false properties: aa_creator: $ref: "#/components/schemas/AutoRouterV2CreatorConfig" aa_evaluations: additionalProperties: format: "double" type: - "number" - "null" type: "object" aa_median_output_tokens_per_second: format: "double" type: "number" aa_median_time_to_first_answer_token: format: "double" type: "number" aa_median_time_to_first_token_seconds: format: "double" type: "number" aa_model_id: type: "string" aa_name: type: "string" aa_pricing: additionalProperties: format: "double" type: - "number" - "null" type: "object" aa_release_date: type: "string" aa_slug: type: "string" default_effort: type: "string" intelligence_index: format: "double" type: "number" price: format: "double" type: "number" reasoning_efforts: additionalProperties: $ref: "#/components/schemas/AutoRouterV2EffortConfig" type: "object" required: - "intelligence_index" - "price" type: "object" AutoRouterV2CreatorConfig: additionalProperties: false properties: id: type: "string" name: type: "string" slug: type: "string" required: - "id" - "name" - "slug" type: "object" AutoRouterV2EffortConfig: additionalProperties: false properties: aa_slug: type: "string" intelligence_index: format: "double" type: "number" required: - "intelligence_index" type: "object" AzureFoundryDeployment: additionalProperties: false properties: base_url: type: "string" id: type: "string" master_data: $ref: "#/components/schemas/AzureFoundryDeploymentMasterData" model: type: "string" publisher: type: "string" wire: type: "string" required: - "id" - "model" type: "object" AzureFoundryDeploymentMasterData: additionalProperties: false properties: has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: "number" metadata: additionalProperties: {} type: "object" model_developer: type: - "string" - "null" model_family: type: - "string" - "null" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" parameters: items: {} type: - "array" - "null" required: - "input_cost" - "output_cost" - "has_functions" - "model_type" - "id" - "model_id" - "parameters" - "model_developer" - "model_family" type: "object" AzureFoundryDeploymentsRequest: additionalProperties: false properties: api_key: type: "string" api_version: type: "string" base_url: type: "string" provider: type: "string" required: - "provider" - "base_url" - "api_key" type: "object" BudgetLimit: additionalProperties: false properties: amount: format: "double" maximum: 1000000 minimum: 0.01 type: "number" currency: enum: - "usd" type: "string" period: enum: - "hour" - "day" - "week" - "month" type: "string" required: - "amount" - "period" - "currency" type: "object" CreateAwsBedrockModelRequest: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" auth_mode: type: "string" autorouter_id: type: "string" autorouter_version: type: "string" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" integration_id: type: "string" max_tokens: format: "int64" type: "integer" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_adaptive_reasoning: type: "boolean" supports_extended_thinking: type: "boolean" supports_json_mode: type: "boolean" supports_json_schema: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "model_id" - "region" - "model_developer" - "auth_mode" type: "object" CreateGuardrailRuleRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" timeout: format: "int64" minimum: 1000 type: "integer" required: - "display_name" type: "object" CreateModelParameter: additionalProperties: false properties: config: additionalProperties: {} type: "object" description: type: "string" hints: type: "string" name: type: "string" parameter: type: "string" parameter_type: type: "string" position: format: "int64" type: "integer" required: - "name" - "parameter" - "config" - "parameter_type" type: "object" CreateModelRequest: additionalProperties: false properties: configuration: additionalProperties: {} type: "object" display_name: maxLength: 128 type: "string" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: "number" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: maxLength: 256 type: "string" model_type: type: "string" output_cost: format: "double" type: "number" parameters: items: $ref: "#/components/schemas/CreateModelParameter" type: - "array" - "null" provider: type: "string" required: - "id" - "display_name" - "model_id" - "model_developer" - "model_family" - "model_type" - "provider" - "has_functions" - "input_cost" - "output_cost" - "metadata" - "parameters" - "configuration" type: "object" CreateOpenAILikeModelRequest: additionalProperties: false properties: api_key: type: "string" base_url: type: "string" cost_per_image: format: "double" type: "number" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_image_edit: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "region" - "base_url" - "model_id" - "api_key" - "model_type" type: "object" CreatePolicyRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" timeout: format: "int64" minimum: 1000 type: "integer" required: - "display_name" type: "object" CreateRoutingRuleRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" required: - "display_name" type: "object" CreateVertexModelRequest: additionalProperties: false properties: configuration: $ref: "#/components/schemas/VertexConfiguration" display_name: type: "string" required: - "display_name" - "configuration" type: "object" EnableModelRequest: additionalProperties: false properties: model_id: type: "string" required: - "model_id" type: "object" EvaluatorRef: additionalProperties: false properties: execute_on: enum: - "input" - "output" - "both" type: "string" id: minLength: 1 type: "string" is_guardrail: type: "boolean" options: additionalProperties: {} type: "object" sample_rate: format: "double" maximum: 1 minimum: 0 type: "number" required: - "id" - "execute_on" type: "object" Expression: additionalProperties: false properties: cel: maxLength: 2000 minLength: 1 type: "string" config: additionalProperties: {} type: "object" required: - "cel" type: "object" ExpressionInput: additionalProperties: false properties: cel: maxLength: 2000 type: "string" required: - "cel" type: "object" GuardrailRef: additionalProperties: false properties: execute_on: enum: - "input" - "output" - "both" type: "string" id: minLength: 1 type: "string" is_guardrail: type: "boolean" options: additionalProperties: {} type: "object" sample_rate: format: "double" maximum: 1 minimum: 0 type: "number" required: - "id" - "execute_on" type: "object" GuardrailRule: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" plugins: items: $ref: "#/components/schemas/Plugin" type: - "array" - "null" project_id: type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "timeout" type: "object" Limits: additionalProperties: false properties: budget: $ref: "#/components/schemas/BudgetLimit" requests: $ref: "#/components/schemas/RequestLimit" tokens: $ref: "#/components/schemas/TokenLimit" type: "object" LiteLLMModel: additionalProperties: false properties: litellm_params: $ref: "#/components/schemas/LiteLLMParams" model_info: $ref: "#/components/schemas/LiteLLMModelInfo" model_name: type: "string" required: - "model_name" - "litellm_params" - "model_info" type: "object" LiteLLMModelInfo: additionalProperties: false properties: db_model: type: - "boolean" - "null" id: type: - "string" - "null" input_cost_per_token: format: "double" type: "number" key: type: - "string" - "null" litellm_provider: type: - "string" - "null" max_input_tokens: format: "int64" type: "integer" max_output_tokens: format: "int64" type: "integer" mode: type: - "string" - "null" output_cost_per_token: format: "double" type: "number" supported_openai_params: items: type: "string" type: - "array" - "null" supports_function_calling: type: "boolean" supports_native_streaming: type: "boolean" supports_reasoning: type: "boolean" supports_response_schema: type: "boolean" supports_system_messages: type: "boolean" supports_tool_choice: type: "boolean" supports_vision: type: "boolean" required: - "id" - "db_model" - "key" - "litellm_provider" - "mode" type: "object" LiteLLMParams: additionalProperties: false properties: merge_reasoning_content_in_choices: type: "boolean" model: type: "string" use_in_pass_through: type: "boolean" use_litellm_proxy: type: "boolean" required: - "use_in_pass_through" - "use_litellm_proxy" - "merge_reasoning_content_in_choices" - "model" type: "object" ModelConfigurationResponse: additionalProperties: false properties: api_key_env: type: "string" api_version: type: "string" auth_mode: type: "string" auth_type: type: "string" base_url: type: "string" deployment_name: type: "string" endpoint: type: "string" inference_profile_arn: type: "string" integration_id: type: "string" is_openai_compatible: type: "boolean" is_tuned_model: type: "boolean" location: type: "string" project_id: type: "string" provider: type: "string" region: type: "string" should_use_beta_features: type: "boolean" subtype: type: "string" workspace_id: type: "string" required: - "provider" type: "object" ModelDocument: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" ModelMetadata: additionalProperties: false properties: allowed_passthrough_parameters: items: type: "string" type: - "array" - "null" autorouter: $ref: "#/components/schemas/AutoRouterConfig" cached_image_input_cost: format: "double" type: "number" cached_input_cost: format: "double" type: "number" chain_of_thought: type: "boolean" context_length: format: "int64" type: "integer" context_window: format: "int64" type: "integer" cost_efficiency_rating: format: "int64" type: "integer" cost_per_image: format: "double" type: "number" deprecation_date: type: "string" embedding_dimensions: format: "int64" type: "integer" extended_context_pricing_mode: type: "string" extended_context_threshold: format: "int64" type: "integer" generate_audio: type: "boolean" image_input_cost: format: "double" type: "number" image_output_cost: format: "double" type: "number" image_token_cost: format: "double" type: "number" intelligence_rating: format: "int64" type: "integer" is_private: type: "boolean" is_realtime: type: "boolean" knowledge_cutoff: type: "string" max_images_per_request: format: "int64" type: "integer" max_input_tokens: format: "int64" type: "integer" max_output_tokens: format: "int64" type: "integer" max_temperature: format: "double" type: "number" million_searches_cost: format: "double" type: "number" million_tokens_above_128k_cache_read_cost: format: "double" type: "number" million_tokens_above_128k_cache_write_cost: format: "double" type: "number" million_tokens_above_128k_input_cost: format: "double" type: "number" million_tokens_above_128k_output_cost: format: "double" type: "number" million_tokens_above_200k_cache_read_cost: format: "double" type: "number" million_tokens_above_200k_cache_write_cost: format: "double" type: "number" million_tokens_above_200k_input_cost: format: "double" type: "number" million_tokens_above_200k_output_cost: format: "double" type: "number" million_tokens_audio_input_cost: format: "double" type: "number" million_tokens_audio_output_cost: format: "double" type: "number" million_tokens_batches_input_cost: format: "double" type: "number" million_tokens_batches_output_cost: format: "double" type: "number" million_tokens_cache_read_cost: format: "double" type: "number" million_tokens_cache_write_1h_cost: format: "double" type: "number" million_tokens_cache_write_5m_cost: format: "double" type: "number" million_tokens_cache_write_cost: format: "double" type: "number" million_tokens_input_cost: format: "double" type: "number" million_tokens_output_cost: format: "double" type: "number" million_tokens_reasoning_cost: format: "double" type: "number" multilingual: type: "boolean" offline: type: "boolean" per_video_second_cost: format: "double" type: "number" per_video_second_cost_1080p: format: "double" type: "number" pricing: $ref: "#/components/schemas/Pricing" reasoning_cost: format: "double" type: "number" reasoning_tokens: format: "int64" type: "integer" region: type: "string" speed_rating: format: "int64" type: "integer" supported_video_aspect_ratios: items: type: "string" type: - "array" - "null" supported_video_durations: items: format: "int64" type: "integer" type: - "array" - "null" supported_video_frame_images: items: type: "string" type: - "array" - "null" supported_video_resolutions: items: type: "string" type: - "array" - "null" supported_video_sizes: items: type: "string" type: - "array" - "null" supports_adaptive_reasoning: type: "boolean" supports_audio_input: type: "boolean" supports_audio_output: type: "boolean" supports_b64_json_response_format: type: "boolean" supports_batch_api: type: "boolean" supports_cache_control: type: "boolean" supports_citations: type: "boolean" supports_code_execution: type: "boolean" supports_commercial_use: type: "boolean" supports_computer_use: type: "boolean" supports_developer_message: type: "boolean" supports_direct_cost: type: "boolean" supports_distillation: type: "boolean" supports_extended_thinking: type: "boolean" supports_fine_tuning: type: "boolean" supports_image_edit: type: "boolean" supports_image_input: type: "boolean" supports_image_output: type: "boolean" supports_images: type: "boolean" supports_json_mode_response_format: type: "boolean" supports_json_schema_response_format: type: "boolean" supports_max_completion_tokens: type: "boolean" supports_openai_sdk: type: "boolean" supports_parallel_tool_calls: type: "boolean" supports_pdf_input: type: "boolean" supports_prompt_caching: type: "boolean" supports_reasoning: type: "boolean" supports_reasoning_effort_default: type: "boolean" supports_reasoning_effort_high: type: "boolean" supports_reasoning_effort_low: type: "boolean" supports_reasoning_effort_max: type: "boolean" supports_reasoning_effort_medium: type: "boolean" supports_reasoning_effort_minimal: type: "boolean" supports_reasoning_effort_none: type: "boolean" supports_reasoning_effort_xhigh: type: "boolean" supports_responses_api: type: "boolean" supports_sampling_params: type: "boolean" supports_service_tier: type: "boolean" supports_streaming: type: "boolean" supports_strict_tool: type: "boolean" supports_structured_outputs: type: "boolean" supports_system_message: type: "boolean" supports_text: type: "boolean" supports_text_input: type: "boolean" supports_text_output: type: "boolean" supports_tool_calling: type: "boolean" supports_tool_choice: type: "boolean" supports_url_context: type: "boolean" supports_url_response_format: type: "boolean" supports_video_input: type: "boolean" supports_video_output: type: "boolean" supports_video_seed: type: "boolean" supports_vision: type: "boolean" supports_web_search: type: "boolean" supports_zdr: type: "boolean" thinking_enforced: type: "boolean" required: - "is_private" type: "object" ModelParameterDocument: additionalProperties: false properties: config: additionalProperties: {} type: "object" description: type: - "string" - "null" hints: type: "string" id: type: "string" is_active: type: "boolean" name: type: "string" parameter: type: "string" parameter_type: type: "string" position: format: "int64" type: "integer" required: - "id" - "name" - "parameter" - "description" - "config" - "parameter_type" - "is_active" type: "object" ModelRef: additionalProperties: false properties: display_name: type: "string" integration_id: type: "string" model: minLength: 1 type: "string" weight: format: "double" maximum: 1 minimum: 0 type: "number" required: - "model" type: "object" ModelSharingConfig: additionalProperties: false properties: allow_fork: type: "boolean" allow_version_pin: type: "boolean" auto_grant_new_projects: type: "boolean" mode: type: "string" project_ids: items: type: "string" type: - "array" - "null" required: - "mode" - "allow_version_pin" - "allow_fork" - "auto_grant_new_projects" type: "object" ModelsConfig: additionalProperties: false properties: mode: enum: - "fallback" - "latency_based" - "weighted" - "round_robin" type: "string" models: items: $ref: "#/components/schemas/ModelRef" minItems: 1 type: - "array" - "null" required: - "mode" - "models" type: "object" PIIRedactionPlugin: additionalProperties: false properties: entities: items: type: "string" type: - "array" - "null" id: type: "string" language: type: "string" on_failure: type: "string" threshold: format: "double" type: "number" required: - "id" type: "object" Plugin: additionalProperties: false properties: OfPIIRedaction: $ref: "#/components/schemas/PIIRedactionPlugin" OfResponseHealing: $ref: "#/components/schemas/ResponseHealingPlugin" required: - "OfPIIRedaction" - "OfResponseHealing" type: "object" Policy: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" slug: minLength: 1 type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "slug" - "enabled" - "timeout" type: "object" PolicyRetryConfig: additionalProperties: false properties: count: format: "int64" maximum: 5 minimum: 1 type: "integer" on_codes: items: format: "int64" type: "integer" type: - "array" - "null" required: - "count" type: "object" Price: additionalProperties: false properties: cost: format: "double" type: "number" currency: type: "string" per: format: "int64" type: "integer" unit: type: "string" required: - "cost" - "currency" - "unit" - "per" type: "object" Pricing: additionalProperties: false properties: cache_read: $ref: "#/components/schemas/Price" cache_write_1h: $ref: "#/components/schemas/Price" cache_write_5m: $ref: "#/components/schemas/Price" input: $ref: "#/components/schemas/Price" output: $ref: "#/components/schemas/Price" reasoning: $ref: "#/components/schemas/Price" variants: items: $ref: "#/components/schemas/PricingVariant" type: - "array" - "null" type: "object" PricingVariant: additionalProperties: false properties: cache_read: $ref: "#/components/schemas/Price" cache_write_1h: $ref: "#/components/schemas/Price" cache_write_5m: $ref: "#/components/schemas/Price" input: $ref: "#/components/schemas/Price" output: $ref: "#/components/schemas/Price" reasoning: $ref: "#/components/schemas/Price" when: type: "string" required: - "when" type: "object" RequestLimit: additionalProperties: false properties: amount: format: "int64" maximum: 1000000000 minimum: 1 type: "integer" period: enum: - "hour" - "day" - "week" - "month" type: "string" required: - "amount" - "period" type: "object" RoutingRule: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: type: "string" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "priority" type: "object" TokenLimit: additionalProperties: false properties: amount: format: "int64" maximum: 1000000000 minimum: 1 type: "integer" period: enum: - "hour" - "day" - "week" - "month" type: "string" required: - "amount" - "period" type: "object" UpdateAwsBedrockModelRequest: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" autorouter_id: type: "string" autorouter_version: type: "string" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_developer: type: "string" model_family: type: "string" model_id: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_adaptive_reasoning: type: "boolean" supports_extended_thinking: type: "boolean" supports_json_mode: type: "boolean" supports_json_schema: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" type: "object" UpdateGuardrailRuleRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: "array" timeout: format: "int64" minimum: 1000 type: "integer" type: "object" UpdateModelParameter: additionalProperties: false properties: config: additionalProperties: {} type: "object" description: type: "string" hints: type: "string" id: type: "string" is_active: type: "boolean" name: type: "string" parameter: type: "string" parameter_type: type: "string" position: format: "int64" type: "integer" required: - "id" type: "object" UpdateModelRequest: additionalProperties: false properties: display_name: maxLength: 128 type: "string" has_functions: type: "boolean" input_cost: format: "double" type: "number" metadata: $ref: "#/components/schemas/ModelMetadata" model_type: type: "string" output_cost: format: "double" type: "number" parameters: items: $ref: "#/components/schemas/UpdateModelParameter" type: "array" type: "object" UpdateOpenAILikeModelRequest: additionalProperties: false properties: base_url: type: "string" cost_per_image: format: "double" type: "number" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_image_edit: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "region" - "model_type" type: "object" UpdatePolicyRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: "array" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: description: "Optional project ID to assign the policy to." type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" timeout: format: "int64" minimum: 1000 type: "integer" type: "object" UpdateRoutingRuleRequest: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" type: "object" ValidateAwsBedrockRequest: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" auth_mode: type: "string" inference_profile_arn: type: "string" integration_id: type: "string" model_type: type: "string" region: type: "string" required: - "inference_profile_arn" - "region" - "auth_mode" type: "object" ValidateModelRequest: additionalProperties: false properties: api_key: type: "string" api_version: type: "string" base_url: type: "string" deployment_name: type: "string" endpoint: type: "string" provider: type: "string" subtype: type: "string" required: - "provider" - "api_key" type: "object" VertexCapabilities: additionalProperties: false properties: structuredOutput: type: "boolean" supportToolCalling: type: "boolean" vision: type: "boolean" required: - "supportToolCalling" - "structuredOutput" - "vision" type: "object" VertexConfiguration: additionalProperties: false properties: location: type: "string" modelConfiguration: $ref: "#/components/schemas/VertexModelConfiguration" projectId: type: "string" serviceAccount: additionalProperties: {} type: "object" required: - "projectId" - "location" - "serviceAccount" - "modelConfiguration" type: "object" VertexModelConfiguration: additionalProperties: false properties: capabilities: $ref: "#/components/schemas/VertexCapabilities" id: type: "string" inputCost: format: "double" type: "number" outputCost: format: "double" type: "number" parameters: $ref: "#/components/schemas/VertexParameters" required: - "id" - "inputCost" - "outputCost" - "parameters" - "capabilities" type: "object" VertexParamRange: additionalProperties: false properties: max: format: "double" type: "number" min: format: "double" type: "number" required: - "min" - "max" type: "object" VertexParamRangeInt: additionalProperties: false properties: max: format: "int64" type: "integer" min: format: "int64" type: "integer" required: - "min" - "max" type: "object" VertexParameters: additionalProperties: false properties: maxTokens: $ref: "#/components/schemas/VertexParamRangeInt" temperature: $ref: "#/components/schemas/VertexParamRange" topP: $ref: "#/components/schemas/VertexParamRange" required: - "temperature" - "maxTokens" - "topP" type: "object" ListActivitiesResponse: type: "object" properties: object: type: "string" data: type: "array" items: $ref: "#/components/schemas/Activity" has_more: type: "boolean" CreateActivityRequest: type: "object" properties: type: $ref: "#/components/schemas/ActivityType" project_id: type: "string" content: type: "string" parent_activity_id: type: "string" mentions: type: "array" items: $ref: "#/components/schemas/ActivityMention" checksum: type: "string" version: type: "string" description: type: "string" data: type: "object" entity_type: type: "string" CreateActivityResponse: type: "object" properties: activity: $ref: "#/components/schemas/Activity" UpdateActivityRequest: type: "object" properties: content: type: "string" environments: $ref: "#/components/schemas/ActivityEnvironments" UpdateActivityResponse: type: "object" properties: activity: $ref: "#/components/schemas/Activity" Activity: type: "object" properties: activity_id: type: "string" type: $ref: "#/components/schemas/ActivityType" workspace_id: type: "string" project_id: type: "string" entity_id: type: "string" account_id: type: "string" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" content: type: "string" parent_activity_id: type: "string" mentions: type: "array" items: $ref: "#/components/schemas/ActivityMention" is_edited: type: "boolean" edited_at: type: "string" format: "date-time" checksum: type: "string" version: type: "string" description: type: "string" environments: type: "array" items: type: "string" data: type: "object" entity_type: type: "string" ActivityType: type: "string" enum: - "ACTIVITY_TYPE_UNSPECIFIED" - "ACTIVITY_TYPE_COMMENT" - "ACTIVITY_TYPE_VERSION" ActivityMention: type: "object" properties: user_id: type: "string" display_name: type: "string" ActivityEnvironments: type: "object" properties: values: type: "array" items: type: "string" ListAlertsResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Alert" description: "Page of alerts, ordered newest first." has_more: type: "boolean" description: "Whether more alerts are available in the selected pagination\n direction." CreateAlertRequest: required: - "display_name" - "project_id" - "query" - "condition" type: "object" properties: display_name: type: "string" description: "Workspace-unique display name." description: type: "string" description: "Short human-readable summary of what the alert watches." project_id: type: "string" description: "Project that owns the alert. Required." signal: type: "string" description: "UI signal preset the alert is created from. Defaults to `custom`." query: allOf: - $ref: "#/components/schemas/AlertQuery" description: "Metric query evaluated on each tick." condition: allOf: - $ref: "#/components/schemas/AlertCondition" description: "Threshold condition applied to the query result." notifier_ids: type: "array" items: type: "string" description: "Notifiers that receive trigger-open and trigger-resolve\n notifications." enabled: type: "boolean" description: "Whether the alert starts evaluating immediately. Defaults to true." CreateAlertResponse: required: - "alert" type: "object" properties: alert: allOf: - $ref: "#/components/schemas/Alert" description: "Newly created alert." GetAlertResponse: required: - "alert" type: "object" properties: alert: allOf: - $ref: "#/components/schemas/Alert" description: "Requested alert." DeleteAlertResponse: type: "object" properties: {} UpdateAlertRequest: required: [] type: "object" properties: display_name: type: "string" description: "New workspace-unique display name. Omit to keep the current name." description: type: "string" description: "New description. Omit to keep the current description." signal: type: "string" description: "New UI signal preset. Omit to keep the current value." query: allOf: - $ref: "#/components/schemas/AlertQuery" description: "Replacement query. Omit to keep the current query." condition: allOf: - $ref: "#/components/schemas/AlertCondition" description: "Replacement condition. Omit to keep the current condition." notifier_ids: type: "array" items: type: "string" description: "Replacement notifier set. Omit to keep the current notifiers." enabled: type: "boolean" description: "New enabled state. Omit to keep the current state." UpdateAlertResponse: required: - "alert" type: "object" properties: alert: allOf: - $ref: "#/components/schemas/Alert" description: "Updated alert." ListAlertTriggersResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/AlertTrigger" description: "Page of triggers, ordered newest first." has_more: type: "boolean" description: "Whether more triggers are available in the selected pagination\n direction." ListAlertTriggerEventsResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/AlertTriggerEvent" description: "Page of events, ordered newest first." has_more: type: "boolean" description: "Whether more events are available in the selected pagination\n direction." Alert: required: - "alert_id" - "display_name" - "description" - "project_id" - "signal" - "query" - "condition" - "notifier_ids" - "enabled" - "status" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" type: "object" properties: alert_id: type: "string" description: "Unique alert identifier assigned by ORQ, for example `alert_01H...`.\n Use this value in retrieve, update, and delete requests." display_name: type: "string" description: "Workspace-unique display name." description: type: "string" description: "Short human-readable summary of what the alert watches." project_id: type: "string" description: "Project that owns the alert. Immutable after creation." signal: enum: - "cost" - "latency" - "errors" - "evals" - "custom" type: "string" description: "UI signal preset the alert was created from." query: allOf: - $ref: "#/components/schemas/AlertQuery" description: "Metric query evaluated on each tick." condition: allOf: - $ref: "#/components/schemas/AlertCondition" description: "Threshold condition applied to the query result." notifier_ids: type: "array" items: type: "string" description: "Notifiers that receive trigger-open and trigger-resolve\n notifications." enabled: type: "boolean" description: "Whether the alert is evaluated. Disabled alerts keep their trigger\n history but stop firing." status: enum: - "ok" - "degraded" - "triggered" type: "string" description: "Current runtime status, maintained by the evaluation engine." last_triggered_at: type: "string" description: "Time when the alert last opened a trigger." format: "date-time" recent_runs: type: "array" items: $ref: "#/components/schemas/AlertRun" description: "Rolling window of the most recent evaluation ticks, oldest first.\n Maintained by the evaluation engine; read-only." created_at: type: "string" description: "Time when the alert was created." format: "date-time" updated_at: type: "string" description: "Time when the alert was last updated." format: "date-time" created_by_id: type: "string" description: "User ID that created the alert." updated_by_id: type: "string" description: "User ID that last updated the alert." AlertQuery: required: - "metric" type: "object" properties: metric: type: "string" description: "Reporting API catalogue metric, e.g. `genai.cost` or\n `genai.latency.avg`. Validated against the catalogue when the alert\n is saved." filters: type: "array" items: $ref: "#/components/schemas/MonitorFilter" description: "Reporting filters combined with AND." AlertCondition: required: - "comparator" - "threshold" - "window" - "interval" type: "object" properties: comparator: enum: - "gt" - "gte" - "lt" - "lte" - "eq" type: "string" description: "Comparison applied as `value threshold`." threshold: type: "number" description: "Critical-tier threshold. Breaching it opens (or escalates) a\n trigger at critical severity." format: "double" degraded_threshold: type: "number" description: "Optional degraded-tier threshold. Values past it but short of\n `threshold` open a trigger at degraded severity. Must sit on the\n recovery side of `threshold` for the chosen comparator and is not\n supported with `eq`." format: "double" resolve_threshold: type: "number" description: "Optional custom resolve bound (hysteresis). An open trigger\n resolves only once the value recovers past this bound; defaults to\n the lowest configured tier. Must sit at or past that tier on the\n recovery side. Not supported with `eq`." format: "double" window: enum: - "5m" - "15m" - "30m" - "1h" - "4h" - "1d" type: "string" description: "Look-back window aggregated on each evaluation tick." interval: enum: - "30s" - "5m" - "15m" - "1h" - "1d" type: "string" description: "How often the alert is evaluated. `30s` is a testing cadence." delay: enum: - "30s" - "60s" - "120s" - "300s" - "600s" type: "string" description: "Ingestion delay subtracted from the evaluation window. Defaults to `120s`." AlertTrigger: required: - "trigger_id" - "alert_id" - "project_id" - "status" - "opened_at" - "peak_value" - "last_value" - "event_count" type: "object" properties: trigger_id: type: "string" description: "Unique trigger identifier, for example `trigger_01H...`." alert_id: type: "string" description: "Alert this trigger belongs to." project_id: type: "string" description: "Project that owns the alert." status: enum: - "open" - "resolved" type: "string" description: "Whether the breach is ongoing or recovered." severity: enum: - "critical" - "degraded" type: "string" description: "Current tier of the incident." peak_severity: enum: - "critical" - "degraded" type: "string" description: "Worst tier reached while the trigger was open." opened_at: type: "string" description: "Time when the threshold was first crossed." format: "date-time" resolved_at: type: "string" description: "Time when the value recovered. Unset while the trigger is open." format: "date-time" peak_value: type: "number" description: "Worst observed value while the trigger was open." format: "double" last_value: type: "number" description: "Most recent observed value." format: "double" event_count: type: "integer" description: "Number of evaluation events recorded on this trigger." format: "int32" AlertTriggerEvent: required: - "event_id" - "trigger_id" - "alert_id" - "at" - "value" type: "object" properties: event_id: type: "string" description: "Unique event identifier, for example `alertevent_01H...`." trigger_id: type: "string" description: "Trigger the event was recorded on." alert_id: type: "string" description: "Alert the event belongs to." at: type: "string" description: "Time of the evaluation tick." format: "date-time" value: type: "number" description: "Observed metric value at the tick." format: "double" evidence: type: "array" items: $ref: "#/components/schemas/AlertEvidence" description: "Exemplar traces that contributed to the breach, worst first." AlertRun: required: - "at" - "value" - "breached" - "has_data" type: "object" properties: at: type: "string" description: "Time of the evaluation tick." format: "date-time" value: type: "number" description: "Observed metric value. Zero when `has_data` is false." format: "double" breached: type: "boolean" description: "Whether the value breached the alert condition." has_data: type: "boolean" description: "Whether the evaluation window contained any data." severity: enum: - "critical" - "degraded" type: "string" description: "Tier the value landed in when breached. Empty when not breached." MonitorFilter: required: - "field" - "op" - "values" type: "object" properties: field: type: "string" description: "Reporting dimension to filter on. Valid fields depend on the\n metric; validated when the monitor is saved." op: enum: - "eq" - "neq" - "in" - "not_in" type: "string" description: "Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values." values: type: "array" items: type: "string" description: "Values compared against the selected field." AlertEvidence: required: - "trace_id" - "span_id" - "start_time" - "value" type: "object" properties: trace_id: type: "string" description: "Trace the exemplar span belongs to." span_id: type: "string" description: "Exemplar span ID." start_time: type: "string" description: "Start time of the exemplar span." format: "date-time" value: type: "number" description: "Metric contribution of the exemplar (e.g. cost or duration)." format: "double" ApiKeyStatus: type: "string" enum: - "API_KEY_STATUS_UNSPECIFIED" - "API_KEY_STATUS_ACTIVE" - "API_KEY_STATUS_DISABLED" - "API_KEY_STATUS_REVOKED" OwnerType: type: "string" enum: - "OWNER_TYPE_UNSPECIFIED" - "OWNER_TYPE_USER" - "OWNER_TYPE_SERVICE_ACCOUNT" PermissionMode: type: "string" enum: - "PERMISSION_MODE_UNSPECIFIED" - "PERMISSION_MODE_ALL" - "PERMISSION_MODE_RESTRICTED" - "PERMISSION_MODE_READ_ONLY" ListApiKeysResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/ApiKey" description: "Page of api-keys, ordered newest first. `token_hash` and\n `api_key` are always elided in list responses." has_more: type: "boolean" description: "Whether more api-keys are available in the selected pagination\n direction." CreateApiKeyRequest: required: - "name" type: "object" properties: name: type: "string" description: "Human-readable name. Required." owner: allOf: - $ref: "#/components/schemas/ApiKeyOwner" description: "Owner attribution. Defaults to service_account when omitted." project_scope: allOf: - $ref: "#/components/schemas/ProjectScope" description: "Project authorization scope. Defaults to all-projects when omitted." permission_mode: description: "Permission preset. Defaults to PERMISSION_MODE_ALL when omitted." $ref: "#/components/schemas/PermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Per-domain access map. Required when `permission_mode` =\n `PERMISSION_MODE_RESTRICTED`. See `ApiKey.access` for the full\n catalog of valid keys (Domain.id) and AccessLevel string values,\n or fetch the live catalog via the capability catalog endpoint." expires_at: type: "string" description: "Optional expiration. When set, the authenticate hot-path rejects\n the key once `expires_at` is in the past. Unset means the key\n never expires." format: "date-time" mcp_access: allOf: - $ref: "#/components/schemas/McpAccess" description: "Optional MCP-gateway access restriction. Unset means no\n restriction. See McpAccess for the deny_all / allow-list semantics." CreateApiKeyResponse: required: - "api_key" - "token" type: "object" properties: api_key: allOf: - $ref: "#/components/schemas/ApiKey" description: "Newly minted api-key record." token: type: "string" description: "Raw bearer token in the form `sk-orq--`.\n Returned ONCE; the API never exposes this value again. Clients\n must persist it immediately on receipt." ListCapabilitiesResponse: required: - "domains" type: "object" properties: domains: type: "array" items: $ref: "#/components/schemas/Domain" description: "Full capability catalog. Order is stable: workspace-admin first,\n then platform, then gateway." GetApiKeyResponse: required: - "api_key" type: "object" properties: api_key: allOf: - $ref: "#/components/schemas/ApiKey" description: "Requested api-key. Raw token never included." DeleteApiKeyResponse: type: "object" properties: {} UpdateApiKeyRequest: required: [] type: "object" properties: name: type: "string" description: "New name. Omit to keep current." status: description: "New lifecycle status. Omit to keep current." $ref: "#/components/schemas/ApiKeyStatus" permission_mode: description: "New permission preset. Omit to keep current." $ref: "#/components/schemas/PermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Replacement access map. Required when changing to\n `PERMISSION_MODE_RESTRICTED`; ignored otherwise. Provide an empty\n map to clear. See `ApiKey.access` for the full catalog of valid\n keys (Domain.id) and AccessLevel string values, or fetch the\n live catalog via the capability catalog endpoint." project_scope: allOf: - $ref: "#/components/schemas/ProjectScope" description: "New project scope. Omit to keep current." expires_at: type: "string" description: "New expiration. Omit to keep current. Set `clear_expires_at = true`\n to remove an existing expiration (a zero Timestamp here would still\n mean \"no change\" because of optional semantics)." format: "date-time" clear_expires_at: type: "boolean" description: "Force-clear the expiration. Mutually exclusive with `expires_at`." mcp_access: allOf: - $ref: "#/components/schemas/McpAccess" description: "Replacement MCP-gateway access restriction. Absent leaves the\n current value intact; an explicitly-set McpAccess replaces it —\n including an empty one (deny_all=false + empty list), which clears\n any existing restriction. See McpAccess." UpdateApiKeyResponse: required: - "api_key" type: "object" properties: api_key: allOf: - $ref: "#/components/schemas/ApiKey" description: "Updated api-key." ApiKey: required: - "api_key_id" - "name" - "owner" - "project_scope" - "permission_mode" - "token_prefix" - "status" - "created_at" - "updated_at" type: "object" properties: api_key_id: type: "string" description: "Canonical key identifier (ULID). Embedded in opaque tokens as\n `sk-orq--`." name: type: "string" description: "Human-readable name shown in the dashboard." owner: allOf: - $ref: "#/components/schemas/ApiKeyOwner" description: "Owner attribution (drives lifecycle)." project_scope: allOf: - $ref: "#/components/schemas/ProjectScope" description: "Project authorization scope." permission_mode: description: "Permission preset. `all` and `read_only` resolve at auth time from\n the capability catalog. `restricted` reads the per-domain `access`\n map." $ref: "#/components/schemas/PermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Per-domain access map. Only populated when `permission_mode` is\n `PERMISSION_MODE_RESTRICTED`. The authoritative list of valid\n keys and the per-domain read / write semantics are exposed at\n runtime via the capability catalog endpoint.\n\n Valid keys are the Domain.id values in the capability catalog —\n see libs/catalog/orq/apikeys/v1/catalog.textpb for the canonical\n list. The ids are intentionally not duplicated here to avoid drift.\n\n Values are AccessLevel enum names on the JSON wire:\n \"ACCESS_LEVEL_NONE\" — capability not granted\n \"ACCESS_LEVEL_READ\" — list / view verbs\n \"ACCESS_LEVEL_WRITE\" — list / view + mutating / execute verbs" token_prefix: type: "string" description: "Displayable prefix for UI listings (e.g. \"sk-orq-01HXY...\"). Safe\n to expose." status: description: "Lifecycle status." $ref: "#/components/schemas/ApiKeyStatus" created_by_id: type: "string" description: "Audit: user who created the key. Optional. Distinct from\n `owner.user_id` — created_by is provenance only, while owner\n determines lifecycle binding." updated_by_id: type: "string" description: "Audit: user who last updated the key." created_at: type: "string" description: "Time the key was created." format: "date-time" updated_at: type: "string" description: "Time the key was last updated." format: "date-time" last_used_at: type: "string" description: "Last authenticated use. Updated via NATS debounce + 1% sampler." format: "date-time" expires_at: type: "string" description: "Optional expiration. The authenticate hot-path rejects keys whose\n `expires_at` is in the past. Unset means the key never expires." format: "date-time" legacy_token_family: description: "Token family marker used by the legacy adapter to route validation." $ref: "#/components/schemas/LegacyTokenFamily" legacy_key_id: type: "string" description: "Legacy MongoDB `_id` from before the canonical ULID was assigned.\n Used by the adapter to resolve a JWT back to this canonical record." budget: readOnly: true allOf: - $ref: "#/components/schemas/Budget" description: "The budget scoped to this api-key, if one exists. Read-only here:\n budgets are created and managed through the Budgets API\n (scope.api_key). Populated only when the read request sets\n `include_budget`. Live consumption (`usage`) is not attached on this\n path — call the Budgets API for current spend." mcp_access: allOf: - $ref: "#/components/schemas/McpAccess" description: "Optional MCP-gateway access restriction. Unset means the key can\n reach every MCP gateway allowed by its project scope. See\n McpAccess for the deny_all / allow-list semantics." description: "ApiKey is the canonical record stored in MongoDB `auth.apiKeys`.\n It is the source of truth for scope, permissions, owner, budget,\n expiration, and revocation (see ADR 0001)." ApiKeyOwner: type: "object" properties: user: $ref: "#/components/schemas/UserOwner" service_account: $ref: "#/components/schemas/ServiceAccountOwner" description: "Owner attribution drives lifecycle.\n\n `service_account` keys are workspace-owned and outlive any individual\n user. `user` keys are bound to `user_id`: when the user is removed,\n disabled, or loses project access, the key is revoked / its scope\n shrinks per the cascade rules in ADR 0001." ProjectScope: type: "object" properties: all: $ref: "#/components/schemas/AllProjects" single: $ref: "#/components/schemas/SingleProject" description: "Project authorization scope. Single-project or all-projects.\n Multi-project use cases are served by minting per-project keys or by\n using an all-projects key with `restricted` mode." McpAccess: type: "object" properties: deny_all: type: "boolean" description: "When true, the key is denied every MCP gateway regardless of\n allowed_mcp_gateway_ids." allowed_mcp_gateway_ids: type: "array" items: type: "string" description: "Allow-list of MCP gateway ids (`mcp_gateway_`) the key may\n reach. Ignored when deny_all is true. Empty (with deny_all=false)\n means no restriction." toolset_ids: type: "array" items: type: "string" description: "Allow-list of MCP toolset ids (`mcp_toolset_`) the key is\n bound to. When non-empty, the key sees and may call only the tools\n that are both exposed by the target gateway and members of the\n union of these toolsets. Empty means no toolset restriction." description: "McpAccess optionally restricts which MCP gateways an API key may\n reach at the data plane. It is orthogonal to permission_mode /\n access: the key must still hold the `mcp_gateway.execute` verb and\n project membership; McpAccess only narrows the reachable gateway set\n within that grant. Human sessions and keys without an McpAccess are\n unaffected.\n\n Semantics:\n - absent, or deny_all=false with an empty allowed_mcp_gateway_ids:\n no restriction — every gateway in the key's project scope is\n reachable.\n - deny_all=true: zero gateways are reachable. Wins over\n allowed_mcp_gateway_ids.\n - non-empty allowed_mcp_gateway_ids: only the listed gateway ids\n are reachable. Each id must look like `mcp_gateway_`." Domain: type: "object" properties: id: type: "string" description: "Stable domain identifier (e.g. \"api-key\", \"budget\"). Used as the\n key in ManagementKey.access and as the verb prefix in resolved\n permissions (e.g. budget.list, budget.view, budget.create)." display_name: type: "string" description: "Human-readable label for the dashboard." group: type: "integer" description: "Logical group used by the UI to render this entry." format: "enum" readable: type: "boolean" description: "Whether this domain can be granted read access." writable: type: "boolean" description: "Whether this domain can be granted write access." description: "Domain describes a permission domain that can be granted to a\n management key. Verbs are derived from id + readable/writable." LegacyTokenFamily: type: "string" enum: - "LEGACY_TOKEN_FAMILY_UNSPECIFIED" - "LEGACY_TOKEN_FAMILY_ROUTER_JWT" - "LEGACY_TOKEN_FAMILY_PROJECT_JWT" - "LEGACY_TOKEN_FAMILY_WORKSPACE_JWT" Budget: required: - "budget_id" - "limits" - "created_at" - "updated_at" type: "object" properties: budget_id: type: "string" scope: allOf: - $ref: "#/components/schemas/BudgetScope" description: "Denormalized metadata for UI rendering, list filters, and the\n resolver's prefilter index. Never consulted for matching — the\n `match` expression is the single source of matching semantics.\n Unset for budgets created from a raw CEL expression (\"custom\")." match: allOf: - $ref: "#/components/schemas/BudgetMatch" description: "The matching semantics of the budget. The enforcement resolver\n evaluates `match.cel` against the request context; a budget\n applies to a request if and only if the expression evaluates to\n true. Scoped creates derive a canonical expression (e.g.\n `provider == \"openai\"`); an empty expression always matches\n (workspace-wide)." limits: $ref: "#/components/schemas/BudgetLimits" rate_limit: $ref: "#/components/schemas/RateLimit" is_active: type: "boolean" expires_at: type: "string" format: "date-time" created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" usage: allOf: - $ref: "#/components/schemas/BudgetUsage" description: "Live consumption for the current period, read from the Redis\n counters the enforcement gate maintains. Populated by read paths\n (Get / List); omitted on write responses (Create / Update / Reset)\n where it carries no signal. Absent or all-zero for a budget that\n has not been spent against in the current period." alerts: type: "array" items: $ref: "#/components/schemas/BudgetAlert" description: "Threshold notifications. Absent when the budget has none." description: "Budget is the canonical record stored in MongoDB `budgets.entities`.\n It replaces the embedded `constraints.budget` on api-keys and the\n legacy CONTACT-only `budgets.configs` collection (see ADR 0007)." UserOwner: required: - "user_id" type: "object" properties: user_id: type: "string" description: "User ID that owns the API key." ServiceAccountOwner: type: "object" properties: {} AllProjects: type: "object" properties: {} SingleProject: required: - "project_id" type: "object" properties: project_id: type: "string" description: "Project ID this API key is scoped to." BudgetScope: type: "object" properties: workspace: $ref: "#/components/schemas/WorkspaceBudgetScope" project: $ref: "#/components/schemas/ProjectBudgetScope" identity: $ref: "#/components/schemas/IdentityBudgetScope" api_key: $ref: "#/components/schemas/ApiKeyBudgetScope" provider: $ref: "#/components/schemas/ProviderBudgetScope" model: $ref: "#/components/schemas/ModelBudgetScope" description: "BudgetScope is a closed oneof. Exactly one variant must be set. The\n six variants are ordered by enforcement precedence (most specific to\n most general) and mirror the BudgetScopeKind filter enum." BudgetMatch: type: "object" properties: cel: type: "string" description: "BudgetMatch carries the CEL expression that decides whether a budget\n applies to a request. Available variables: `model`, `provider`,\n `model_id`, `api_key`, `identity`, `project`, `metadata` (map),\n `headers` (map, lowercase keys). An empty expression always matches.\n Expressions are syntax-validated at write time." BudgetLimits: type: "object" properties: period: $ref: "#/components/schemas/BudgetPeriod" amount: type: "number" format: "double" token_limit: type: "number" description: "Token ceiling. Carried as a double so it serializes as a JSON number\n (proto int64 would serialize as a quoted string); token counts are\n whole and well within double's exact-integer range (2^53). Stored as\n an integer server-side." format: "double" description: "BudgetLimits is the per-period spend and token ceiling. At least one\n of `amount`, `token_limit`, or RateLimit.requests_per_minute MUST be\n set on a Budget; that invariant is enforced by the handler." RateLimit: type: "object" properties: requests_per_minute: type: "integer" format: "int32" description: "RateLimit is the per-minute request ceiling. Enforced via atomic\n increment-first semantics in the enforcement middleware." BudgetUsage: type: "object" properties: amount: type: "number" format: "double" tokens: type: "number" description: "Carried as a double (not int64) so it serializes as a JSON number\n rather than a quoted string, matching limits.token_limit." format: "double" requests: type: "integer" format: "int32" description: "BudgetUsage is the current-period consumption of a budget, sourced\n from the live Redis counters (not the exact ledger). Each dimension is\n the consumed side of the matching limit dimension: `amount` is the\n accumulated cost in USD (vs limits.amount), `tokens` is the accumulated\n token count (vs limits.token_limit), and `requests` is the count in the\n rolling 60-second window (vs rate_limit.requests_per_minute). All three\n are explicit-presence so the triple is always emitted in full, zeros\n included — a never-spent budget serializes {amount:0, tokens:0,\n requests:0} rather than dropping its zero dimensions." BudgetAlert: required: - "threshold_percent" - "notifier_ids" type: "object" properties: id: type: "string" description: "Assigned by ORQ. Supply an existing id to edit that alert in place." threshold_percent: type: "integer" description: "Percentage of the dimension's limit at which the alert fires, 1–100." format: "uint32" notifier_ids: type: "array" items: type: "string" description: "Must be workspace-scoped; project-scoped notifiers are rejected." dimension: description: "Defaults to COST when unset." $ref: "#/components/schemas/BudgetAlertDimension" description: "Notifies every listed notifier once current-period consumption on\n `dimension` reaches `threshold_percent` of the matching limit. Each alert\n fires at most once per period, re-arming on rollover or a limit change.\n The dimension must have a limit set, or the write is rejected." WorkspaceBudgetScope: type: "object" properties: {} description: "Workspace-wide ceiling. The implicit target is the caller's workspace." ProjectBudgetScope: type: "object" properties: project_id: type: "string" description: "Per-project cap." IdentityBudgetScope: type: "object" properties: identity_external_id: type: "string" description: "Per-identity cap. Keyed by the contact's external_id (not the\n internal Mongo `_id`) so the scope is stable across imports." ApiKeyBudgetScope: type: "object" properties: api_key_id: type: "string" description: "Per-api-key cap. Replaces the legacy embedded `constraints.budget`\n on auth.apiKeys." ProviderBudgetScope: type: "object" properties: provider: type: "string" description: "Per-provider cap. The value is the provider enum string (e.g.\n \"openai\", \"anthropic\") drawn from ModelIntegrationIdentifier." ModelBudgetScope: required: - "model_id" type: "object" properties: model_id: type: "string" description: "Per-model cap. The value is the FULL model reference as callers send\n it (\"openai/gpt-4o\", or \"workspaceKey@openai/gpt-4o\" for private\n models) — NOT the Mongo `_id` of the model master-data document." BudgetPeriod: type: "string" enum: - "BUDGET_PERIOD_UNSPECIFIED" - "BUDGET_PERIOD_DAILY" - "BUDGET_PERIOD_WEEKLY" - "BUDGET_PERIOD_MONTHLY" - "BUDGET_PERIOD_YEARLY" - "BUDGET_PERIOD_ONE_TIME" BudgetAlertDimension: type: "string" enum: - "BUDGET_ALERT_DIMENSION_UNSPECIFIED" - "BUDGET_ALERT_DIMENSION_COST" - "BUDGET_ALERT_DIMENSION_TOKENS" BudgetScopeKind: type: "string" enum: - "BUDGET_SCOPE_KIND_UNSPECIFIED" - "BUDGET_SCOPE_KIND_WORKSPACE" - "BUDGET_SCOPE_KIND_PROJECT" - "BUDGET_SCOPE_KIND_IDENTITY" - "BUDGET_SCOPE_KIND_API_KEY" - "BUDGET_SCOPE_KIND_PROVIDER" - "BUDGET_SCOPE_KIND_MODEL" BudgetSortField: type: "string" enum: - "BUDGET_SORT_FIELD_UNSPECIFIED" - "BUDGET_SORT_FIELD_EXPIRES_AT" - "BUDGET_SORT_FIELD_CREATED_AT" - "BUDGET_SORT_FIELD_UPDATED_AT" ListBudgetsResponse: required: - "object" - "data" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/BudgetRestResponse" description: "Page of budgets, ordered newest first." hasMore: type: "boolean" description: "Whether more budgets are available in the selected pagination\n direction." default: false CreateBudgetRequest: type: "object" properties: scope: allOf: - $ref: "#/components/schemas/BudgetScope" description: "Structured scope. Mutually exclusive with `match`: provide a scope\n for the six canonical kinds (the server derives the matching CEL),\n or provide `match` for a dynamic budget. Exactly one of the two\n must be set; the handler enforces that invariant." match: allOf: - $ref: "#/components/schemas/BudgetMatch" description: "Raw CEL matching expression for dynamic budgets (e.g.\n `metadata.team == \"ml\" && provider == \"openai\"`). Validated via\n CEL parse at write time. Mutually exclusive with `scope`." limits: allOf: - $ref: "#/components/schemas/BudgetLimits" description: "At least one of amount / token_limit / rate_limit.requests_per_minute\n must be provided on the budget; the handler enforces that invariant." rate_limit: allOf: - $ref: "#/components/schemas/RateLimit" description: "Optional rate limit." is_active: type: "boolean" description: "Whether the budget should be active immediately. Defaults to true\n when omitted (handler enforces)." expires_at: type: "string" description: "Optional expiration. When set in combination with is_active=true,\n the value MUST be in the future; the handler rejects past values." format: "date-time" alerts: type: "array" items: $ref: "#/components/schemas/BudgetAlert" description: "Optional threshold notifications. Ids are assigned by the server, so\n `alerts[].id` must be omitted here; supplying one is rejected." CreateBudgetResponse: required: - "budget" type: "object" properties: budget: allOf: - $ref: "#/components/schemas/BudgetRestResponse" description: "Newly created budget." GetBudgetResponse: required: - "budget" type: "object" properties: budget: allOf: - $ref: "#/components/schemas/BudgetRestResponse" description: "Requested budget." DeleteBudgetResponse: type: "object" properties: {} UpdateBudgetRequest: type: "object" properties: limits: allOf: - $ref: "#/components/schemas/BudgetLimits" description: "New limits. Omit to keep current." rate_limit: allOf: - $ref: "#/components/schemas/RateLimit" description: "New rate limit. Omit to keep current." is_active: type: "boolean" description: "New active state. Omit to keep current." expires_at: type: "string" description: "New expiration. Omit to keep current. Set `clear_expires_at = true`\n to remove an existing expiration." format: "date-time" clear_expires_at: type: "boolean" description: "Force-clear the expiration. Mutually exclusive with `expires_at`." match: allOf: - $ref: "#/components/schemas/BudgetMatch" description: "New matching expression. Only valid for dynamic budgets (no\n structured scope) — the scope of a scoped budget is immutable, so\n its derived expression is too. Validated via CEL parse." alerts: type: "array" items: $ref: "#/components/schemas/BudgetAlert" description: "Replaces the alert list wholesale. Omit to keep the current alerts.\n An entry with a known `id` is edited in place; one with no id is minted." clear_alerts: type: "boolean" description: "Force-clear every alert. Mutually exclusive with a non-empty `alerts`." UpdateBudgetResponse: required: - "budget" type: "object" properties: budget: allOf: - $ref: "#/components/schemas/BudgetRestResponse" description: "Updated budget." ResetBudgetConsumptionRequest: type: "object" properties: {} ResetBudgetConsumptionResponse: type: "object" properties: budget: allOf: - $ref: "#/components/schemas/BudgetRestResponse" description: "Budget after reset. The record itself is unchanged; only counters\n were cleared." BudgetRestResponse: required: - "budgetId" - "limits" - "createdAt" - "updatedAt" type: "object" properties: budgetId: type: "string" scope: allOf: - $ref: "#/components/schemas/BudgetScopeRestResponse" description: "Denormalized metadata for UI rendering, list filters, and the\n resolver's prefilter index. Never consulted for matching — the\n `match` expression is the single source of matching semantics.\n Unset for budgets created from a raw CEL expression (\"custom\")." match: allOf: - $ref: "#/components/schemas/BudgetMatch" description: "The matching semantics of the budget. The enforcement resolver\n evaluates `match.cel` against the request context; a budget\n applies to a request if and only if the expression evaluates to\n true. Scoped creates derive a canonical expression (e.g.\n `provider == \"openai\"`); an empty expression always matches\n (workspace-wide)." limits: $ref: "#/components/schemas/BudgetLimitsRestResponse" rateLimit: $ref: "#/components/schemas/RateLimitRestResponse" isActive: type: "boolean" default: false expiresAt: type: "string" format: "date-time" createdAt: type: "string" format: "date-time" updatedAt: type: "string" format: "date-time" usage: allOf: - $ref: "#/components/schemas/BudgetUsage" description: "Live consumption for the current period, read from the Redis\n counters the enforcement gate maintains. Populated by read paths\n (Get / List); omitted on write responses (Create / Update / Reset)\n where it carries no signal. Absent or all-zero for a budget that\n has not been spent against in the current period." alerts: type: "array" items: $ref: "#/components/schemas/BudgetAlertRestResponse" description: "Threshold notifications. Absent when the budget has none." description: "Budget is the canonical record stored in MongoDB `budgets.entities`.\n It replaces the embedded `constraints.budget` on api-keys and the\n legacy CONTACT-only `budgets.configs` collection (see ADR 0007)." BudgetScopeRestResponse: type: "object" properties: workspace: $ref: "#/components/schemas/WorkspaceBudgetScope" project: $ref: "#/components/schemas/ProjectBudgetScopeRestResponse" identity: $ref: "#/components/schemas/IdentityBudgetScopeRestResponse" apiKey: $ref: "#/components/schemas/ApiKeyBudgetScopeRestResponse" provider: $ref: "#/components/schemas/ProviderBudgetScope" model: $ref: "#/components/schemas/ModelBudgetScopeRestResponse" description: "BudgetScope is a closed oneof. Exactly one variant must be set. The\n six variants are ordered by enforcement precedence (most specific to\n most general) and mirror the BudgetScopeKind filter enum." BudgetLimitsRestResponse: type: "object" properties: period: $ref: "#/components/schemas/BudgetPeriod" amount: type: "number" format: "double" tokenLimit: type: "number" description: "Token ceiling. Carried as a double so it serializes as a JSON number\n (proto int64 would serialize as a quoted string); token counts are\n whole and well within double's exact-integer range (2^53). Stored as\n an integer server-side." format: "double" description: "BudgetLimits is the per-period spend and token ceiling. At least one\n of `amount`, `token_limit`, or RateLimit.requests_per_minute MUST be\n set on a Budget; that invariant is enforced by the handler." RateLimitRestResponse: type: "object" properties: requestsPerMinute: type: "integer" format: "int32" description: "RateLimit is the per-minute request ceiling. Enforced via atomic\n increment-first semantics in the enforcement middleware." BudgetAlertRestResponse: required: - "thresholdPercent" - "notifierIds" type: "object" properties: id: type: "string" description: "Assigned by ORQ. Supply an existing id to edit that alert in place." thresholdPercent: type: "integer" description: "Percentage of the dimension's limit at which the alert fires, 1–100." format: "uint32" notifierIds: type: "array" items: type: "string" description: "Must be workspace-scoped; project-scoped notifiers are rejected." dimension: description: "Defaults to COST when unset." $ref: "#/components/schemas/BudgetAlertDimension" description: "Notifies every listed notifier once current-period consumption on\n `dimension` reaches `threshold_percent` of the matching limit. Each alert\n fires at most once per period, re-arming on rollover or a limit change.\n The dimension must have a limit set, or the write is rejected." ProjectBudgetScopeRestResponse: type: "object" properties: projectId: type: "string" description: "Per-project cap." IdentityBudgetScopeRestResponse: type: "object" properties: identityExternalId: type: "string" description: "Per-identity cap. Keyed by the contact's external_id (not the\n internal Mongo `_id`) so the scope is stable across imports." ApiKeyBudgetScopeRestResponse: type: "object" properties: apiKeyId: type: "string" description: "Per-api-key cap. Replaces the legacy embedded `constraints.budget`\n on auth.apiKeys." ModelBudgetScopeRestResponse: required: - "modelId" type: "object" properties: modelId: type: "string" description: "Per-model cap. The value is the FULL model reference as callers send\n it (\"openai/gpt-4o\", or \"workspaceKey@openai/gpt-4o\" for private\n models) — NOT the Mongo `_id` of the model master-data document." SearchDocumentationRequest: required: - "query" type: "object" properties: query: type: "string" description: "Free-text query to search the documentation for." limit: type: "integer" description: "Maximum number of results to return (1-50). Defaults to 10." format: "int32" score_threshold: type: "number" description: "Minimum relevance score (0-1). Defaults to 0.6." format: "double" SearchDocumentationResponse: required: - "results" type: "object" properties: results: type: "array" items: $ref: "#/components/schemas/DocumentationSearchResult" description: "Documentation pages matching the query, ordered by relevance." DocumentationSearchResult: required: - "content" - "path" - "metadata" type: "object" properties: content: type: "string" description: "Matching content snippet from the documentation page." path: type: "string" description: "Path of the documentation page within the docs site." metadata: allOf: - $ref: "#/components/schemas/DocumentationSearchResultMetadata" description: "Display metadata for rendering the result." DocumentationSearchResultMetadata: required: - "title" - "description" - "href" type: "object" properties: title: type: "string" description: "Page title." description: type: "string" description: "Short page description." href: type: "string" description: "Absolute URL to the documentation page." icon: type: "string" description: "Optional icon identifier for the page." ListFeaturePreviewsResponse: type: "object" properties: previews: type: "array" items: $ref: "#/components/schemas/FeaturePreview" ToggleFeaturePreviewRequest: type: "object" properties: enabled: type: "boolean" description: "Desired enabled state." ToggleFeaturePreviewResponse: type: "object" properties: preview: $ref: "#/components/schemas/FeaturePreview" FeaturePreview: type: "object" properties: slug: type: "string" description: "Stable identifier of the feature (e.g. \"sidebar_v2\")." name: type: "string" description: "Human-readable name shown in the list." summary: type: "string" description: "Short one-line summary." description_markdown: type: "string" description: "Markdown body describing the feature." requires_refresh: type: "boolean" description: "Whether the page must be reloaded for the change to take effect." order: type: "integer" description: "Display order in the list." format: "int32" enabled: type: "boolean" description: "Whether the current user has this feature enabled." ListFilesResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/File" description: "Page of files." has_more: type: "boolean" description: "Whether more files are available in the selected pagination direction." CreateFileRequest: required: - "filename" - "content" type: "object" properties: filename: type: "string" description: "Name to store for the uploaded file, including extension when available." content: type: "string" description: "Base64-encoded file contents." format: "bytes" purpose: description: "Intended usage category for the uploaded file. Defaults to retrieval\n when omitted." $ref: "#/components/schemas/FilePurpose" content_type: type: "string" description: "MIME type of the uploaded content, for example `application/pdf`." project_id: type: "string" description: "Project the file is created in. Optional: project-scoped API keys default to the key's bound project; workspace-scoped callers default to the workspace's default project." CreateFileResponse: required: - "file" type: "object" properties: file: allOf: - $ref: "#/components/schemas/File" description: "Newly created file." GetFileContentResponse: required: - "download_url" type: "object" properties: download_url: type: "string" description: "Presigned URL that can be used to download the file content." GetFileResponse: required: - "file" type: "object" properties: file: allOf: - $ref: "#/components/schemas/File" description: "Requested file metadata." DeleteFileResponse: type: "object" properties: {} UpdateFileRequest: required: - "file_name" type: "object" properties: file_name: type: "string" description: "New display file name, including extension when available." UpdateFileResponse: required: - "file" type: "object" properties: file: allOf: - $ref: "#/components/schemas/File" description: "Updated file metadata." File: required: - "file_id" - "purpose" - "file_name" - "bytes" - "created_at" - "project_id" type: "object" properties: file_id: type: "string" description: "Unique file identifier assigned by ORQ." purpose: description: "Declared usage category for the file." $ref: "#/components/schemas/FilePurpose" file_name: type: "string" description: "Display file name, including extension when available." bytes: type: "string" description: "Size of the uploaded file in bytes." created_at: type: "string" description: "Time when the file was created." format: "date-time" project_id: type: "string" description: "Identifier of the project the file belongs to. Files are project-scoped; an API key may only access files in projects it is authorized for." FilePurpose: type: "string" enum: - "FILE_PURPOSE_UNSPECIFIED" - "FILE_PURPOSE_RETRIEVAL" - "FILE_PURPOSE_KNOWLEDGE_DATASOURCE" - "FILE_PURPOSE_BATCH" - "FILE_PURPOSE_CODE_INTERPRETER" ListFinderEntitiesResponse: required: - "object" - "data" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/FinderItem" description: "All finder entities visible to the caller. Not paginated." FinderItem: required: - "_id" - "type" - "display_name" - "workspace_id" type: "object" properties: id: type: "string" description: "Unique entity identifier. Serialized as `_id` for parity with the\n finder collection and the frontend FinderItem shape." type: type: "string" description: "Discriminator for the heterogeneous finder collection, e.g.\n \"project\", \"directory\", \"skill\", \"prompt\", \"agent\", \"dataset\"." display_name: type: "string" description: "Human-readable name shown in the navigation tree." description: type: "string" description: "Optional description of the entity." workspace_id: type: "string" description: "Workspace that owns the entity." project_id: type: "string" description: "Project the entity belongs to. Null for structural roots (projects)." parent_id: type: "string" description: "Parent finder node (directory or project). Null for roots." key: type: "string" description: "Optional stable key used by some entity types (e.g. tools)." created_by_id: type: "string" description: "Identifier of the user who created the entity." updated_by_id: type: "string" description: "Identifier of the user who last updated the entity." metadata: type: "object" description: "Free-form metadata stored with the entity." created_at: type: "string" description: "ISO timestamp for when the entity was created." updated_at: type: "string" description: "ISO timestamp for when the entity was last updated." IdentitySortField: type: "string" enum: - "IDENTITY_SORT_FIELD_UNSPECIFIED" - "IDENTITY_SORT_FIELD_DISPLAY_NAME" - "IDENTITY_SORT_FIELD_UPDATED" ListIdentitiesResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Identity" description: "Page of identities." has_more: type: "boolean" description: "Whether more identities are available in the selected pagination\n direction." CreateIdentityRequest: required: - "external_id" type: "object" properties: external_id: type: "string" description: "Customer-provided stable identifier for this identity. Must be unique\n within the workspace." display_name: type: "string" description: "Human-readable display name for the identity." email: type: "string" description: "Email address associated with the identity." avatar_url: type: "string" description: "URL of the identity avatar image." tags: type: "array" items: type: "string" description: "Free-form labels used to organize and filter identities." metadata: type: "object" additionalProperties: true description: "Custom JSON metadata stored with the identity." CreateIdentityResponse: required: - "identity" type: "object" properties: identity: allOf: - $ref: "#/components/schemas/Identity" description: "Newly created identity." RetrieveIdentityResponse: required: - "identity" type: "object" properties: identity: allOf: - $ref: "#/components/schemas/Identity" description: "Requested identity." DeleteIdentityResponse: type: "object" properties: {} UpdateIdentityRequest: required: [] type: "object" properties: display_name: type: "string" description: "New display name. Omit to keep the current display name." email: type: "string" description: "New email address. Omit to keep the current email." avatar_url: type: "string" description: "New avatar image URL. Omit to keep the current avatar URL." tags: type: "array" items: type: "string" description: "Replacement tag list. Leave empty to clear tags." metadata: type: "object" additionalProperties: true description: "Replacement custom JSON metadata." UpdateIdentityResponse: required: - "identity" type: "object" properties: identity: allOf: - $ref: "#/components/schemas/Identity" description: "Updated identity." Identity: required: - "_id" - "external_id" - "workspace_id" - "created" - "updated" type: "object" properties: _id: type: "string" description: "Unique identity identifier assigned by ORQ. Returned as `_id` for\n compatibility with the v1 identity API." external_id: type: "string" description: "Customer-provided stable identifier for this identity. This value is\n required on create and is unique within the workspace." workspace_id: type: "string" description: "Workspace that owns the identity." display_name: type: "string" description: "Human-readable display name for the identity." email: type: "string" description: "Email address associated with the identity." avatar_url: type: "string" description: "URL of the identity avatar image." tags: type: "array" items: type: "string" description: "Free-form labels used to organize and filter identities." metadata: type: "object" additionalProperties: true description: "Custom JSON metadata stored with the identity." created: type: "string" description: "ISO timestamp for when the identity was created." updated: type: "string" description: "ISO timestamp for when the identity was last updated." metrics: allOf: - $ref: "#/components/schemas/IdentityMetrics" description: "Optional usage and cost metrics. Present only when requested with\n `include_metrics`." budget: readOnly: true allOf: - $ref: "#/components/schemas/Budget" description: "The budget scoped to this identity, if one exists. Read-only here:\n budgets are created and managed through the Budgets API\n (scope.identity). Present only when requested with `include_budget`.\n Live consumption (`usage`) is not attached on this path — call the\n Budgets API for current spend." IdentityMetrics: required: - "total_tokens" - "total_cost" - "total_requests" - "error_rate" type: "object" properties: total_tokens: type: "number" description: "Total token count attributed to the identity." format: "double" total_cost: type: "number" description: "Total cost attributed to the identity." format: "double" total_requests: type: "number" description: "Total request count attributed to the identity." format: "double" error_rate: type: "number" description: "Fraction of attributed requests that failed." format: "double" ManagementKeyStatus: type: "string" enum: - "MANAGEMENT_KEY_STATUS_UNSPECIFIED" - "MANAGEMENT_KEY_STATUS_ACTIVE" - "MANAGEMENT_KEY_STATUS_DISABLED" - "MANAGEMENT_KEY_STATUS_REVOKED" ManagementPermissionMode: type: "string" enum: - "MANAGEMENT_PERMISSION_MODE_UNSPECIFIED" - "MANAGEMENT_PERMISSION_MODE_ALL" - "MANAGEMENT_PERMISSION_MODE_RESTRICTED" - "MANAGEMENT_PERMISSION_MODE_READ_ONLY" ListManagementKeysResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/ManagementKey" description: "Page of management-keys, ordered newest first. `token_hash` and\n `api_key` are always elided in list responses." has_more: type: "boolean" description: "Whether more management-keys are available in the selected pagination\n direction." CreateManagementKeyRequest: required: - "name" type: "object" properties: name: type: "string" description: "Human-readable name. Required." permission_mode: description: "Permission preset. Defaults to MANAGEMENT_PERMISSION_MODE_ALL when omitted." $ref: "#/components/schemas/ManagementPermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Per-domain access map. Required when `permission_mode` =\n `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. See `ManagementKey.access`\n for the catalog of valid keys (Domain.id) and AccessLevel string\n values, or fetch the live catalog via the capability catalog\n endpoint." expires_at: type: "string" description: "Optional expiration. When set, the authenticate hot-path rejects\n the key once `expires_at` is in the past. Unset means the key\n never expires." format: "date-time" CreateManagementKeyResponse: required: - "management_key" - "token" type: "object" properties: management_key: allOf: - $ref: "#/components/schemas/ManagementKey" description: "Newly minted management-key record." token: type: "string" description: "Raw bearer token in the form `sk-orq--`.\n Returned ONCE; the API never exposes this value again." ListManagementCapabilitiesResponse: required: - "domains" type: "object" properties: domains: type: "array" items: $ref: "#/components/schemas/Domain" description: "Full management capability catalog." GetManagementKeyResponse: required: - "management_key" type: "object" properties: management_key: allOf: - $ref: "#/components/schemas/ManagementKey" description: "Requested management-key. Raw token never included." DeleteManagementKeyResponse: type: "object" properties: {} UpdateManagementKeyRequest: required: [] type: "object" properties: name: type: "string" description: "New name. Omit to keep current." status: description: "New lifecycle status. Omit to keep current." $ref: "#/components/schemas/ManagementKeyStatus" permission_mode: description: "New permission preset. Omit to keep current." $ref: "#/components/schemas/ManagementPermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Replacement access map. Required when changing to\n `MANAGEMENT_PERMISSION_MODE_RESTRICTED`; ignored otherwise. Provide\n an empty map to clear." expires_at: type: "string" description: "New expiration. Omit to keep current. Set `clear_expires_at = true`\n to remove an existing expiration." format: "date-time" clear_expires_at: type: "boolean" description: "Force-clear the expiration. Mutually exclusive with `expires_at`." UpdateManagementKeyResponse: required: - "management_key" type: "object" properties: management_key: allOf: - $ref: "#/components/schemas/ManagementKey" description: "Updated management-key." ManagementKey: required: - "management_key_id" - "name" - "permission_mode" - "token_prefix" - "status" - "created_at" - "updated_at" type: "object" properties: management_key_id: type: "string" description: "Canonical key identifier (ULID). Embedded in opaque tokens as\n `sk-orq--`." name: type: "string" description: "Human-readable name shown in the dashboard." permission_mode: description: "Permission preset. `all` and `read_only` resolve at auth time from\n the management capability catalog. `restricted` reads the per-domain\n `access` map." $ref: "#/components/schemas/ManagementPermissionMode" access: type: "object" additionalProperties: type: "integer" format: "enum" description: "Per-domain access map. Only populated when `permission_mode` is\n `MANAGEMENT_PERMISSION_MODE_RESTRICTED`. Valid keys are the Domain.id\n values in the management capability catalog — see\n libs/catalog/orq/managementkeys/v1/catalog.textpb for the canonical\n list." token_prefix: type: "string" description: "Displayable prefix for UI listings (e.g. \"sk-orq-01HXY...\"). Safe\n to expose." status: description: "Lifecycle status." $ref: "#/components/schemas/ManagementKeyStatus" created_by_id: type: "string" description: "Audit: user who created the key." updated_by_id: type: "string" description: "Audit: user who last updated the key." created_at: type: "string" description: "Time the key was created." format: "date-time" updated_at: type: "string" description: "Time the key was last updated." format: "date-time" last_used_at: type: "string" description: "Last authenticated use." format: "date-time" expires_at: type: "string" description: "Optional expiration. The authenticate hot-path rejects keys whose\n `expires_at` is in the past. Unset means the key never expires." format: "date-time" description: "ManagementKey is the canonical record stored in MongoDB\n `auth.managementKeys`. It is the source of truth for permissions,\n expiration, and revocation. Management keys are always\n workspace-scoped — there is no project_scope field, and they have no\n per-user owner (every management key is workspace-owned;\n `created_by_id` records who created it)." Sharing: type: "object" properties: all_projects: allOf: - $ref: "#/components/schemas/SharingAllProjects" description: "Visible to every project in the workspace." selected: allOf: - $ref: "#/components/schemas/SharingSelectedProjects" description: "Visible to the listed projects only." allow_version_pin: type: "boolean" description: "Consuming projects may pin a specific version instead of tracking\n latest. Enforcement lives with the consuming reference." allow_fork: type: "boolean" description: "Projects may duplicate this entity into a detached project-owned\n copy." auto_grant_new_projects: type: "boolean" description: "New projects created after this sharing config is applied should\n receive access automatically. Enforcement lives with project\n creation and entity-specific adoption code." description: "Sharing controls where a workspace-owned entity is visible and what\n consuming projects may do with it. Entities adopt it as one branch of\n a `oneof scope { string project_id; Sharing sharing; }` union:\n project-owned entities carry project_id, workspace-owned entities\n carry sharing. Reads for project-scoped callers include entities\n shared with their projects; mutation of workspace-owned entities is\n reserved for management keys / workspace admins." SetModelSharingResponse: type: "object" properties: model_id: type: "string" sharing: $ref: "#/components/schemas/Sharing" SharingAllProjects: type: "object" properties: {} SharingSelectedProjects: type: "object" properties: project_ids: type: "array" items: type: "string" description: "An empty list is valid and means \"shared with no project\" — the model\n stays in the workspace catalog but no project-scoped caller can use it\n (admins/workspace-wide callers still can). The UI surfaces this as\n \"Custom\" with every project toggled off." NotifierType: type: "string" enum: - "NOTIFIER_TYPE_UNSPECIFIED" - "NOTIFIER_TYPE_EMAIL" - "NOTIFIER_TYPE_SLACK_WEBHOOK" - "NOTIFIER_TYPE_WEBHOOK" ListNotifiersResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Notifier" description: "Page of notifiers." has_more: type: "boolean" description: "Whether more notifiers are available in the selected pagination direction." CreateNotifierRequest: required: - "display_name" - "type" type: "object" properties: project_id: type: "string" description: "Optional. Workspace-scoped callers may set this to create a project-scoped notifier, or omit it for a workspace-wide notifier. Project-scoped API keys create in the API key's project." display_name: type: "string" description: "Required. Human-readable notifier name." metadata: type: "object" description: "Optional. Custom JSON metadata stored with the notifier." type: description: "Required. Destination type. Use `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK`." $ref: "#/components/schemas/NotifierType" emails: type: "array" items: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_EMAIL`. Omit for other notifier types." incoming_webhook_url: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. Omit for other notifier types." webhook_url: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_WEBHOOK`. Omit for other notifier types." headers: type: "object" description: "Optional generic webhook headers. Each value may be a string or `{ \"secret\": true, \"value\": \"...\" }`." description: "Create notifier request. `project_id`, `display_name`, and `type` are always required. The destination field required by `type` is captured in `oneOf`." oneOf: - title: "Email notifier create request" type: "object" description: "`emails` is required when `type` is `NOTIFIER_TYPE_EMAIL`." required: - "type" - "emails" properties: type: type: "string" enum: - "NOTIFIER_TYPE_EMAIL" emails: type: "array" items: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_EMAIL`. Omit for other notifier types." - title: "Slack webhook notifier create request" type: "object" description: "`incoming_webhook_url` is required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`." required: - "type" - "incoming_webhook_url" properties: type: type: "string" enum: - "NOTIFIER_TYPE_SLACK_WEBHOOK" incoming_webhook_url: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`. Omit for other notifier types." - title: "Generic webhook notifier create request" type: "object" description: "`webhook_url` is required when `type` is `NOTIFIER_TYPE_WEBHOOK`; `headers` is optional." required: - "type" - "webhook_url" properties: type: type: "string" enum: - "NOTIFIER_TYPE_WEBHOOK" webhook_url: type: "string" description: "Required when `type` is `NOTIFIER_TYPE_WEBHOOK`. Omit for other notifier types." CreateNotifierResponse: required: - "notifier" type: "object" properties: notifier: $ref: "#/components/schemas/Notifier" GetNotifierResponse: required: - "notifier" type: "object" properties: notifier: $ref: "#/components/schemas/Notifier" DeleteNotifierResponse: type: "object" properties: {} UpdateNotifierRequest: required: [] type: "object" properties: project_id: type: "string" description: "Optional. New containing project. Workspace-scoped callers may set an empty value to make the notifier workspace-wide. Project-scoped API keys remain pinned to the API key's project." display_name: type: "string" description: "Optional. New human-readable notifier name." metadata: type: "object" description: "Optional. Replacement custom JSON metadata." type: description: "Optional. New destination type. When provided, also provide the destination field required by the new type." $ref: "#/components/schemas/NotifierType" emails: type: "array" items: type: "string" description: "Optional replacement email recipients. Required when changing `type` to `NOTIFIER_TYPE_EMAIL`." incoming_webhook_url: type: "string" description: "Optional replacement Slack incoming webhook URL. Required when changing `type` to `NOTIFIER_TYPE_SLACK_WEBHOOK`." webhook_url: type: "string" description: "Optional replacement generic webhook URL. Required when changing `type` to `NOTIFIER_TYPE_WEBHOOK`." headers: type: "object" description: "Optional replacement generic webhook headers. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating." description: "Partial notifier update. All request body fields are optional individually, but at least one field must be provided. When changing `type`, include the destination field required by the new type. Secret header values returned by GET or LIST are masked as an empty string; omit those entries or replace them with the real value when updating." minProperties: 1 UpdateNotifierResponse: required: - "notifier" type: "object" properties: notifier: $ref: "#/components/schemas/Notifier" Notifier: required: - "_id" - "display_name" - "created_at" - "updated_at" - "type" type: "object" properties: _id: type: "string" description: "Unique notifier identifier assigned by ORQ." project_id: type: "string" description: "Project that contains the notifier. Empty for workspace-wide notifiers." display_name: type: "string" description: "Human-readable notifier name." created_at: type: "string" description: "Time when the notifier was created." format: "date-time" updated_at: type: "string" description: "Time when the notifier was last updated." format: "date-time" created_by_id: type: "string" description: "User ID that created the notifier." updated_by_id: type: "string" description: "User ID that last updated the notifier." metadata: type: "object" description: "Custom JSON metadata stored with the notifier." type: description: "Notifier destination type. Use `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK`." $ref: "#/components/schemas/NotifierType" emails: type: "array" items: type: "string" description: "Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`." incoming_webhook_url: type: "string" description: "Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`." webhook_url: type: "string" description: "Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`." headers: type: "object" description: "Optional HTTP headers for generic webhooks. Each entry may be a string value or an object with `secret` and `value`." description: "Notifier resource. The destination field present on the resource depends on `type` and is captured in `oneOf`." oneOf: - title: "Email notifier" type: "object" description: "`emails` is present for email notifiers." required: - "type" - "emails" properties: type: type: "string" enum: - "NOTIFIER_TYPE_EMAIL" emails: type: "array" items: type: "string" description: "Email addresses notified when `type` is `NOTIFIER_TYPE_EMAIL`." - title: "Slack webhook notifier" type: "object" description: "`incoming_webhook_url` is present for Slack webhook notifiers." required: - "type" - "incoming_webhook_url" properties: type: type: "string" enum: - "NOTIFIER_TYPE_SLACK_WEBHOOK" incoming_webhook_url: type: "string" description: "Slack incoming webhook URL used when `type` is `NOTIFIER_TYPE_SLACK_WEBHOOK`." - title: "Generic webhook notifier" type: "object" description: "`webhook_url` is present for generic webhook notifiers; `headers` is optional." required: - "type" - "webhook_url" properties: type: type: "string" enum: - "NOTIFIER_TYPE_WEBHOOK" webhook_url: type: "string" description: "Generic webhook URL used when `type` is `NOTIFIER_TYPE_WEBHOOK`." ListPeopleResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Person" description: "Page of people, ordered newest first." has_more: type: "boolean" description: "Whether more people are available in the selected pagination\n direction." CreatePersonRequest: required: - "emails" type: "object" properties: emails: type: "array" items: type: "string" description: "Email addresses to invite. At least one email is required." roles: type: "array" items: type: "string" description: "Roles to assign. Defaults to [\"member\"] when empty." groups: type: "array" items: type: "string" description: "Group IDs to assign." CreatePersonResponse: required: - "people" type: "object" properties: people: type: "array" items: $ref: "#/components/schemas/Person" description: "Newly created people." GetPersonResponse: required: - "person" type: "object" properties: person: allOf: - $ref: "#/components/schemas/Person" description: "Requested person." DeletePersonResponse: type: "object" properties: {} UpdatePersonRequest: required: [] type: "object" properties: roles: type: "array" items: type: "string" description: "Replacement role list. Leave empty to clear all roles." groups: type: "array" items: type: "string" description: "Replacement group list. Leave empty to clear all groups." clear_roles: type: "boolean" description: "Explicitly clear all roles. Set to true when sending an empty roles array." clear_groups: type: "boolean" description: "Explicitly clear all groups. Set to true when sending an empty groups array." UpdatePersonResponse: required: - "person" type: "object" properties: person: allOf: - $ref: "#/components/schemas/Person" description: "Updated person." ResendInvitationRequest: required: [] type: "object" properties: {} ResendInvitationResponse: required: - "person" type: "object" properties: person: allOf: - $ref: "#/components/schemas/Person" description: "Person whose invitation was resent." Person: required: - "id" - "account_id" - "email" - "display_name" - "roles" - "groups" - "status" - "created_at" - "updated_at" type: "object" properties: id: type: "string" description: "Unique workspace user identifier (ULID)." account_id: type: "string" description: "Linked account ID." email: type: "string" description: "Email address." display_name: type: "string" description: "Full display name (firstname + lastname)." avatar_url: type: "string" description: "Profile image URL." roles: type: "array" items: type: "string" description: "Permission roles assigned to the person." groups: type: "array" items: type: "string" description: "Group IDs the person belongs to (non-support groups)." status: description: "Membership status: pending or active." $ref: "#/components/schemas/PersonStatus" last_activity: type: "string" description: "Last activity timestamp." format: "date-time" created_at: type: "string" description: "When the person was invited or added." format: "date-time" updated_at: type: "string" description: "Last modification timestamp." format: "date-time" PersonStatus: type: "string" enum: - "PERSON_STATUS_UNSPECIFIED" - "PERSON_STATUS_PENDING" - "PERSON_STATUS_ACTIVE" ListProjectsResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Project" description: "Page of projects, ordered newest first." has_more: type: "boolean" description: "Whether more projects are available in the selected pagination\n direction." CreateProjectRequest: required: - "name" type: "object" properties: name: type: "string" description: "Project name. Names must be non-empty and at most 128 characters." teams: type: "array" items: type: "string" description: "Team identifiers to associate with the project." description: type: "string" description: "Optional human-readable description, at most 500 characters." CreateProjectResponse: required: - "project" type: "object" properties: project: allOf: - $ref: "#/components/schemas/Project" description: "Newly created project." GetProjectResponse: required: - "project" type: "object" properties: project: allOf: - $ref: "#/components/schemas/Project" description: "Requested project." DeleteProjectResponse: type: "object" properties: {} UpdateProjectRequest: required: [] type: "object" properties: name: type: "string" description: "New project name. Omit to keep the current name." teams: type: "array" items: type: "string" description: "Replacement list of team identifiers associated with the project.\n Leave empty to remove all team associations." description: type: "string" description: "New project description. Omit to keep the current description." UpdateProjectResponse: required: - "project" type: "object" properties: project: allOf: - $ref: "#/components/schemas/Project" description: "Updated project." Project: required: - "project_id" - "name" - "key" - "is_archived" - "is_default" - "teams" - "created_at" - "updated_at" type: "object" properties: project_id: type: "string" description: "Unique project identifier assigned by ORQ. Use this value in\n retrieve, update, and delete requests." name: type: "string" description: "Human-readable project name." key: type: "string" description: "Stable project key generated from the name and used by internal\n workspace navigation." is_archived: type: "boolean" description: "Whether the project is archived and hidden from normal active\n project lists." is_default: type: "boolean" description: "Whether this is the workspace default project." teams: type: "array" items: type: "string" description: "Team identifiers associated with the project for access and\n organization." created_at: type: "string" description: "Time when the project was created." format: "date-time" updated_at: type: "string" description: "Time when the project was last updated." format: "date-time" created_by_id: type: "string" description: "User ID that created the project." updated_by_id: type: "string" description: "User ID that last updated the project." description: type: "string" description: "Optional human-readable description of the project." ListSkillsResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" description: "Object discriminator for list responses; always `list`." data: type: "array" items: $ref: "#/components/schemas/Skill" description: "Page of skills, ordered newest first." has_more: type: "boolean" description: "Whether more skills are available in the selected pagination\n direction." CreateSkillRequest: required: - "display_name" type: "object" anyOf: - required: - "path" - required: - "project_id" properties: display_name: pattern: "^[A-Za-z][A-Za-z0-9]*(?:[_-][A-Za-z0-9]+)*$" type: "string" description: "Workspace-unique display name. Must start with a letter and may contain letters, numbers, dashes, and underscores. Dots are not allowed." description: type: "string" description: "Short human-readable summary of what the skill is for." tags: type: "array" items: type: "string" description: "Free-form labels for organizing the skill." path: type: "string" description: "Project path where the skill should be stored." project_id: type: "string" description: "Project that should contain the skill." instructions: type: "string" description: "Instruction body for the skill. Omit to create metadata first and fill instructions later." CreateSkillResponse: required: - "skill" type: "object" properties: skill: allOf: - $ref: "#/components/schemas/Skill" description: "Newly created skill." GetSkillResponse: required: - "skill" type: "object" properties: skill: allOf: - $ref: "#/components/schemas/Skill" description: "Requested skill." DeleteSkillResponse: type: "object" properties: {} UpdateSkillRequest: required: [] type: "object" properties: display_name: pattern: "^[A-Za-z][A-Za-z0-9]*(?:[_-][A-Za-z0-9]+)*$" type: "string" description: "New workspace-unique display name. Must start with a letter and may contain letters, numbers, dashes, and underscores. Dots are not allowed." description: type: "string" description: "New description. Omit to keep the current description." tags: type: "array" items: type: "string" description: "Replacement tag list. Leave empty to clear tags." path: type: "string" description: "New project path. Omit to keep the current path." instructions: type: "string" description: "New instruction body. Omit to keep the current instructions." project_id: type: "string" description: "New containing project. Omit to keep the current project." UpdateSkillResponse: required: - "skill" type: "object" properties: skill: allOf: - $ref: "#/components/schemas/Skill" description: "Updated skill." Skill: required: - "skill_id" - "display_name" - "description" - "tags" - "project_id" - "path" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "instructions" - "version" type: "object" properties: skill_id: type: "string" description: "Unique skill identifier assigned by ORQ, for example\n `skill_01H...`. Use this value in retrieve, update, and delete\n requests." display_name: pattern: "^[A-Za-z][A-Za-z0-9]*(?:[_-][A-Za-z0-9]+)*$" type: "string" description: "Workspace-unique display name. Must start with a letter and may contain letters, numbers, dashes, and underscores. Dots are not allowed." description: type: "string" description: "Short human-readable summary of what the skill is for." tags: type: "array" items: type: "string" description: "Free-form labels used for organization and filtering in clients." project_id: type: "string" description: "Project that owns or contains the skill." path: type: "string" description: "Project path where the skill is stored in the workspace." created_at: type: "string" description: "Time when the skill was created." format: "date-time" updated_at: type: "string" description: "Time when the skill was last updated." format: "date-time" created_by_id: type: "string" description: "User ID that created the skill." updated_by_id: type: "string" description: "User ID that last updated the skill." instructions: type: "string" description: "Instruction body executed or reused by clients that load this skill." version: type: "string" description: "Latest semver assigned by the activity log. Stamped on the document\n by CreateSkill / UpdateSkill so reads return it without joining\n workspaces.activities." SmartRouterProfile: type: "string" enum: - "SMART_ROUTER_PROFILE_UNSPECIFIED" - "SMART_ROUTER_PROFILE_QUALITY" - "SMART_ROUTER_PROFILE_BALANCED" - "SMART_ROUTER_PROFILE_COST" ListSmartRoutersResponse: required: - "object" - "data" - "has_more" type: "object" properties: object: type: "string" data: type: "array" items: $ref: "#/components/schemas/SmartRouter" has_more: type: "boolean" CreateSmartRouterRequest: required: - "key" - "models" - "profile" type: "object" properties: key: type: "string" description: "Required. Stable lowercase key containing letters, numbers, and hyphens." models: type: "array" items: type: "string" description: "Required. Ordered pool of distinct models in provider/model format." profile: $ref: "#/components/schemas/SmartRouterProfile" CreateSmartRouterResponse: required: - "smart_router" type: "object" properties: smart_router: $ref: "#/components/schemas/SmartRouter" GetSmartRouterResponse: required: - "smart_router" type: "object" properties: smart_router: $ref: "#/components/schemas/SmartRouter" DeleteSmartRouterResponse: type: "object" properties: {} UpdateSmartRouterRequest: required: [] type: "object" properties: models: type: "array" items: type: "string" profile: $ref: "#/components/schemas/SmartRouterProfile" UpdateSmartRouterResponse: required: - "smart_router" type: "object" properties: smart_router: $ref: "#/components/schemas/SmartRouter" SetSmartRouterEnabledRequest: required: - "enabled" type: "object" properties: enabled: type: "boolean" SetSmartRouterEnabledResponse: required: - "smart_router" type: "object" properties: smart_router: $ref: "#/components/schemas/SmartRouter" SmartRouter: required: - "smart_router_id" - "key" - "model_ref" - "models" - "profile" - "enabled" - "created_at" - "updated_at" type: "object" properties: smart_router_id: type: "string" description: "Unique Smart Router identifier assigned by ORQ." key: type: "string" description: "Stable lowercase key used in the gateway model reference." model_ref: type: "string" description: "Workspace-qualified gateway model reference." models: type: "array" items: type: "string" description: "Ordered model pool in provider/model format, from highest to lowest capability." profile: description: "Routing preference applied to model selection." $ref: "#/components/schemas/SmartRouterProfile" enabled: type: "boolean" description: "Whether the router is available to gateway requests." created_at: type: "string" format: "date-time" updated_at: type: "string" format: "date-time" ListWebhooksResponse: required: - "count" - "items" - "has_more" type: "object" properties: count: type: "integer" description: "Total number of webhooks matching the filters, before pagination." format: "int32" items: type: "array" items: $ref: "#/components/schemas/Webhook" description: "Requested page of webhooks." has_more: type: "boolean" description: "Whether another page of matching webhooks is available." description: "A page of webhooks and the total number of matching records." CreateWebhookRequest: required: - "_id" - "url" - "content_type" - "display_name" - "events" - "secret" type: "object" properties: _id: type: "string" description: "Client-generated webhook ID." url: pattern: "^https://" type: "string" description: "HTTPS endpoint that receives webhook deliveries." format: "uri" content_type: enum: - "application/json" - "application/x-www-form-urlencoded" type: "string" description: "Content type sent with webhook deliveries." display_name: type: "string" description: "Human-readable webhook name." events: minItems: 1 type: "array" items: type: "string" description: "One or more workspace event slugs that trigger a delivery, for example `deployment.invoked` or `llm.response`." secret: writeOnly: true minLength: 1 type: "string" description: "Signing secret returned by `GET /v2/webhooks/secret`. Deliveries set `X-Orq-Signature` to the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes." enabled: type: "boolean" description: "Whether webhook deliveries are enabled." description: "Configuration used to create a webhook in the current workspace." Webhook: required: - "_id" - "url" - "content_type" - "display_name" - "events" - "secret" - "created_by_id" - "updated_by_id" - "created" - "updated" type: "object" properties: _id: type: "string" description: "Unique webhook ID." url: pattern: "^https://" type: "string" description: "HTTPS endpoint that receives webhook deliveries." format: "uri" content_type: enum: - "application/json" - "application/x-www-form-urlencoded" type: "string" description: "Content type sent with webhook deliveries." display_name: type: "string" description: "Human-readable webhook name." events: type: "array" items: type: "string" description: "Workspace event slugs that trigger a delivery, for example `deployment.invoked` or `llm.response`." secret: type: "string" description: "Signing secret used to compute `X-Orq-Signature` as the lowercase hexadecimal HMAC-SHA256 of the exact request body bytes. Treat this value as sensitive." enabled: type: "boolean" description: "Whether webhook deliveries are enabled." failure_count: readOnly: true type: "integer" description: "Server-managed number of consecutive delivery failures." format: "int32" created_by_id: readOnly: true type: "string" description: "Account ID that created the webhook." updated_by_id: readOnly: true type: "string" description: "Account ID that most recently updated the webhook." created: readOnly: true type: "string" description: "Creation time in RFC 3339 format." format: "date-time" updated: readOnly: true type: "string" description: "Most recent update time in RFC 3339 format." format: "date-time" description: "A webhook subscription and its delivery configuration. Responses include the signing secret; treat it as sensitive." CountWebhooksResponse: required: - "total" type: "object" properties: total: type: "integer" description: "Total number of webhooks in the current workspace." format: "int32" description: "Webhook count for the current workspace." QueryWebhooksRequest: type: "object" properties: pagination: $ref: "#/components/schemas/QueryParamsPagination" sortingProps: type: "array" items: $ref: "#/components/schemas/QueryParamsSort" query: type: "object" filters: type: "array" items: type: "object" includedFields: type: "object" additionalProperties: type: "string" QueryWebhooksResponse: required: - "count" - "items" type: "object" properties: count: type: "integer" format: "int32" items: type: "array" items: $ref: "#/components/schemas/Webhook" GenerateWebhookSecretResponse: required: - "secret" type: "object" properties: secret: type: "string" description: "Signing secret to supply when creating or updating a webhook. Store it securely." description: "A newly generated webhook signing secret." DeleteWebhookResponse: required: - "id" type: "object" properties: id: type: "string" description: "ID of the deleted webhook." QueryParamsPagination: type: "object" properties: page: type: "integer" format: "int32" limit: type: "integer" format: "int32" lastId: type: "string" firstId: type: "string" QueryParamsSort: type: "object" properties: key: type: "string" direction: type: "string" GetWorkspaceSettingsResponse: required: - "settings" type: "object" properties: settings: allOf: - $ref: "#/components/schemas/WorkspaceSettings" description: "Current workspace settings." UpdateWorkspaceSettingsRequest: type: "object" properties: display_name: type: "string" description: "New workspace display name. Omit to keep the current name." enforce_enabled_models: type: "boolean" description: "New value for the enforce-enabled-models flag. Omit to keep the current\n value." pii_redaction: allOf: - $ref: "#/components/schemas/PiiRedaction" description: "Replacement workspace-default PII redaction configuration. Omit to leave\n the current PII redaction configuration unchanged; when present it fully\n replaces the stored pii_redaction object." description: "UpdateWorkspaceSettingsRequest is a partial update: every field is optional\n and an omitted field is left unchanged.\n\n There is deliberately no `key` / `slug` field. The workspace slug is\n immutable through this service (it is embedded in resource URLs and API\n credentials), mirroring the dashboard's WorkspaceUpdateGuard, which rejects a\n `key` in the PATCH /workspaces/:key body. Do not add one." UpdateWorkspaceSettingsResponse: required: - "settings" type: "object" properties: settings: allOf: - $ref: "#/components/schemas/WorkspaceSettings" description: "Updated workspace settings." WorkspaceSettings: required: - "key" - "display_name" - "enforce_enabled_models" type: "object" properties: key: type: "string" description: "Read-only workspace key/slug. Returned for reference; it cannot be changed\n through this service." display_name: type: "string" description: "Human-readable workspace display name." enforce_enabled_models: type: "boolean" description: "Whether only workspace-enabled models may be served." pii_redaction: allOf: - $ref: "#/components/schemas/PiiRedaction" description: "Workspace-default PII redaction plugin configuration. Omitted when the\n workspace has never configured it." description: "WorkspaceSettings is the full settings state returned by Get and Update." PiiRedaction: required: - "enabled" type: "object" properties: enabled: type: "boolean" description: "Whether the workspace-default PII redaction plugin is enabled." config: allOf: - $ref: "#/components/schemas/PiiRedactionConfig" description: "Plugin configuration applied when enabled. Optional." description: "PiiRedaction is the workspace-default configuration for the pii_redaction\n plugin: an enable flag plus the optional plugin config the gateway applies as\n a floor for requests that send no plugins of their own." PiiRedactionConfig: type: "object" properties: language: type: "string" description: "Detector language. One of \"en\" or \"nl\"; omit for the gateway default\n (\"en\"). The valid entity catalog depends on this value." entities: type: "array" items: type: "string" description: "Entity types to redact (e.g. \"EMAIL_ADDRESS\", \"PERSON\"). Values are\n validated against the entity catalog for `language`; omit to redact every\n type the detector finds." on_failure: type: "string" description: "Behaviour when redaction cannot run: \"block\" (fail closed, the default) or\n \"passthrough\" (fail open, send the original text)." threshold: type: "number" description: "Detection confidence threshold in the [0, 1] range." format: "double" description: "PiiRedactionConfig mirrors the workspace-default PII redaction plugin config\n (libs/go/models PIIRedactionPlugin / libs/models/gateway\n PIIRedactionPluginSchema). Every field is optional; the gateway applies its\n own defaults for unset fields.\n\n The stored value is validated on write with the same\n models.PIIRedactionPlugin.Validate() the gateway runs per request. Without\n that, an invalid workspace default would 400 every gateway call for the\n workspace, since the default plugin is injected into each request and\n validated there." APIError: additionalProperties: false properties: code: type: - "string" - "null" failures: {} message: type: "string" param: type: - "string" - "null" type: type: "string" required: - "message" - "type" - "param" - "code" type: "object" CacheConfig: additionalProperties: false properties: ttl: format: "int64" type: "integer" type: type: "string" required: - "type" type: "object" ConversationParam: additionalProperties: false properties: id: type: "string" required: - "id" type: "object" EmbeddingCacheConfig: additionalProperties: false properties: ttl: description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." format: "int64" type: "integer" type: description: "Cache type." enum: - "exact_match" type: "string" required: - "type" type: "object" EmbeddingContactParams: additionalProperties: false properties: display_name: type: "string" email: type: "string" id: type: "string" metadata: items: additionalProperties: {} type: "object" type: - "array" - "null" tags: items: type: "string" type: - "array" - "null" required: - "id" type: "object" EmbeddingLoadBalancerConfig: additionalProperties: false properties: models: description: "Array of models with weights for load balancing requests." items: $ref: "#/components/schemas/EmbeddingLoadBalancerModelConfig" type: - "array" - "null" type: description: "Load balancer type." enum: - "weight_based" type: "string" required: - "type" - "models" type: "object" EmbeddingLoadBalancerModelConfig: additionalProperties: false properties: model: description: "Model identifier for load balancing." type: "string" weight: description: "Weight assigned to this model for load balancing." format: "double" type: "number" required: - "model" - "weight" type: "object" EmbeddingOrqParams: additionalProperties: false properties: cache: $ref: "#/components/schemas/EmbeddingCacheConfig" description: "Deprecated: use top-level cache instead." contact: $ref: "#/components/schemas/EmbeddingContactParams" description: "Deprecated: use identity instead. Information about the contact making the request." fallbacks: description: "Deprecated: use top-level fallbacks instead." items: $ref: "#/components/schemas/FallbackConfig" type: - "array" - "null" identity: $ref: "#/components/schemas/PublicIdentity" description: "Information about the identity making the request." load_balancer: $ref: "#/components/schemas/EmbeddingLoadBalancerConfig" description: "Deprecated: use top-level load_balancer instead." name: description: "Deprecated: use top-level name instead." type: "string" retry: $ref: "#/components/schemas/EmbeddingRetryConfig" description: "Deprecated: use top-level retry instead." timeout: $ref: "#/components/schemas/EmbeddingTimeoutConfig" description: "Deprecated: use top-level timeout instead." type: "object" EmbeddingRetryConfig: additionalProperties: false properties: count: description: "Number of retry attempts (1-5)." format: "int64" type: "integer" on_codes: description: "HTTP status codes that trigger retry logic." items: format: "int64" type: "integer" type: - "array" - "null" required: - "count" - "on_codes" type: "object" EmbeddingTimeoutConfig: additionalProperties: false properties: call_timeout: description: "Timeout value in milliseconds." format: "int64" type: "integer" required: - "call_timeout" type: "object" FallbackConfig: additionalProperties: false properties: model: type: "string" required: - "model" type: "object" IncompleteDetails: additionalProperties: false properties: reason: type: "string" required: - "reason" type: "object" InputTokensDetails: additionalProperties: false properties: cache_creation_1h_tokens: format: "int64" type: "integer" cache_creation_5m_tokens: format: "int64" type: "integer" cache_creation_tokens: format: "int64" type: "integer" cached_tokens: format: "int64" type: "integer" required: - "cached_tokens" - "cache_creation_tokens" type: "object" LoadBalancerConfig: additionalProperties: false properties: models: items: $ref: "#/components/schemas/LoadBalancerModelConfig" type: - "array" - "null" type: type: "string" required: - "type" - "models" type: "object" LoadBalancerModelConfig: additionalProperties: false properties: model: type: "string" weight: format: "double" type: "number" required: - "model" - "weight" type: "object" MemoryParam: additionalProperties: false properties: entity_id: type: "string" required: - "entity_id" type: "object" OpenAIContextManagement: additionalProperties: false properties: compact_threshold: format: "int64" type: "integer" type: type: "string" required: - "type" type: "object" OpenAIModeration: additionalProperties: false properties: model: type: "string" policy: $ref: "#/components/schemas/OpenAIModerationPolicy" required: - "model" type: "object" OpenAIModerationPolicy: additionalProperties: false properties: input: $ref: "#/components/schemas/OpenAIModerationPolicyRule" output: $ref: "#/components/schemas/OpenAIModerationPolicyRule" type: "object" OpenAIModerationPolicyRule: additionalProperties: false properties: mode: enum: - "score" - "block" type: "string" required: - "mode" type: "object" OpenAIPrompt: additionalProperties: false properties: id: type: "string" variables: additionalProperties: {} type: "object" version: type: "string" required: - "id" type: "object" OpenAIPromptCacheOptions: additionalProperties: false properties: mode: enum: - "implicit" - "explicit" type: "string" ttl: enum: - "30m" type: "string" type: "object" OrqAdvisorTool: additionalProperties: false description: "Lets the primary model consult a configured secondary model for advice." properties: max_tokens: description: "Maximum secondary-model output tokens. 0 uses the provider default; the selected model may impose a lower maximum." format: "int64" maximum: 128000 minimum: 0 type: "integer" max_transcript_tokens: description: "Maximum estimated conversation-transcript tokens sent to the secondary model. 0 includes the full transcript." format: "int64" minimum: 0 type: "integer" max_uses: description: "Maximum invocations per request. 0 means unlimited." format: "int64" minimum: 0 type: "integer" model: description: "Secondary model in provider/model format." minLength: 1 type: "string" reasoning_effort: description: "Reasoning effort for supported models. Omit to use the provider default." enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" - "max" type: "string" temperature: description: "Sampling temperature. The selected model may impose a lower maximum." format: "double" maximum: 2 minimum: 0 type: "number" type: description: "Advisor tool discriminator." enum: - "orq:advisor" type: "string" required: - "type" - "model" title: "Advisor" type: "object" OrqSidekickTool: additionalProperties: false description: "Lets the primary model delegate a concrete task to a configured secondary model." properties: max_tokens: description: "Maximum secondary-model output tokens. 0 uses the provider default; the selected model may impose a lower maximum." format: "int64" maximum: 128000 minimum: 0 type: "integer" max_uses: description: "Maximum invocations per request. 0 means unlimited." format: "int64" minimum: 0 type: "integer" model: description: "Secondary model in provider/model format." minLength: 1 type: "string" output_format: description: "Optional output-format guidance for the secondary model." type: "string" reasoning_effort: description: "Reasoning effort for supported models. Omit to use the provider default." enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" - "max" type: "string" system_prompt: description: "Optional system prompt for the secondary model." type: "string" temperature: description: "Sampling temperature. The selected model may impose a lower maximum." format: "double" maximum: 2 minimum: 0 type: "number" type: description: "Sidekick tool discriminator." enum: - "orq:sidekick" type: "string" required: - "type" - "model" title: "Sidekick" type: "object" OutputTokensDetails: additionalProperties: false properties: reasoning_tokens: format: "int64" type: "integer" required: - "reasoning_tokens" type: "object" PublicCacheControl: additionalProperties: false properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- 5m: 5 minutes\n- 1h: 1 hour\n\nDefaults to 5m. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" type: "object" PublicCreateEmbeddingBody: additionalProperties: false properties: cache: $ref: "#/components/schemas/EmbeddingCacheConfig" description: "Cache configuration for the request." dimensions: description: "The number of dimensions the resulting output embeddings should have." format: "int64" type: "integer" encoding_format: description: "The format to return the embeddings in. Can be either float or base64." enum: - "float" - "base64" type: "string" fallbacks: description: "Array of fallback models to use if primary model fails." items: $ref: "#/components/schemas/FallbackConfig" type: - "array" - "null" input: anyOf: - description: "A single text string to embed. Must be non-empty." minLength: 1 title: "String" type: "string" - description: "An array of strings or token arrays to embed. Must be non-empty." items: anyOf: - minLength: 1 type: "string" - items: type: "integer" minItems: 1 type: "array" minItems: 1 title: "Array" type: "array" description: "Input text to embed, encoded as a string or array of tokens." load_balancer: $ref: "#/components/schemas/EmbeddingLoadBalancerConfig" description: "Load balancer configuration for the request." model: description: "ID of the model to use." type: "string" name: description: "The name to display on the trace. If not specified, the default system name will be used." type: "string" orq: $ref: "#/components/schemas/EmbeddingOrqParams" description: "Orq platform extension parameters. Top-level equivalents take priority when both are set." retry: $ref: "#/components/schemas/EmbeddingRetryConfig" description: "Retry configuration for the request." timeout: $ref: "#/components/schemas/EmbeddingTimeoutConfig" description: "Timeout configuration to apply to the request." user: description: "A unique identifier representing your end-user." type: "string" required: - "model" - "input" type: "object" PublicCreateResponseBody: additionalProperties: false properties: background: description: "If true, the response runs asynchronously in the background." type: "boolean" cache: $ref: "#/components/schemas/CacheConfig" description: "Exact-match response cache configuration for this request." cache_control: description: "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request." properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" conversation: $ref: "#/components/schemas/ConversationParam" description: "Conversation context for multi-turn interactions." fallbacks: description: "Fallback models to try if the primary model fails. Each entry specifies a model in provider/model format." items: $ref: "#/components/schemas/FallbackConfig" type: - "array" - "null" frequency_penalty: description: "Penalize new tokens based on their frequency in the text so far. Between -2.0 and 2.0." format: "double" type: "number" guardrails: description: "Guardrails to evaluate the request against." items: $ref: "#/components/schemas/EvaluatorRef" type: "array" identity: $ref: "#/components/schemas/ResponseIdentity" description: "Identity/contact information for the end-user." input: anyOf: - description: "A simple text string as input." title: "Text" type: "string" - description: "An array of input items." items: description: "An input item. The \"type\" field determines the item kind: \"message\", \"function_call\", \"function_call_output\", \"item_reference\", etc." properties: arguments: description: "The function arguments as a JSON string (for function_call items)." type: "string" call_id: description: "The function call identifier (for function_call and function_call_output items)." type: "string" content: anyOf: - title: "Text" type: "string" - items: anyOf: - description: "A text content part." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" text: description: "The text content." type: "string" type: enum: - "input_text" type: "string" required: - "type" - "text" title: "Text" type: "object" - description: "An image content part." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" detail: description: "The detail level for image understanding." enum: - "auto" - "low" - "high" type: "string" file_id: description: "The ID of a previously uploaded file." type: "string" image_url: description: "The URL of the image." type: "string" type: enum: - "input_image" type: "string" required: - "type" title: "Image" type: "object" - description: "A file content part. Provide file_id, file_data (base64), or file_url." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" file_data: description: "Base64-encoded file content." type: "string" file_id: description: "The ID of a previously uploaded file." type: "string" file_url: description: "A URL to fetch the file from." type: "string" filename: description: "The name of the file." type: "string" mime_type: description: "The MIME type of the file (e.g., application/pdf)." type: "string" type: enum: - "input_file" type: "string" required: - "type" title: "File" type: "object" description: "A content part within a message." title: "Content parts" type: "array" description: "The content of the item: a string or an array of content parts." id: description: "The ID of the item. For item_reference items, this identifies the referenced item." type: "string" name: description: "The name of the function that was called (for function_call items)." type: "string" output: description: "The output of the function call (for function_call_output type)." type: "string" role: description: "The role of the message sender (for message items)." enum: - "user" - "assistant" - "system" - "developer" type: "string" status: description: "The status of a model-generated input item." enum: - "in_progress" - "completed" - "incomplete" type: "string" type: description: "The type of item." enum: - "message" - "function_call" - "function_call_output" - "item_reference" - "reasoning" - "custom_tool_call" - "custom_tool_call_output" - "computer_call" - "computer_call_output" - "local_shell_call" - "local_shell_call_output" - "shell_call" - "shell_call_output" - "apply_patch_call" - "apply_patch_call_output" - "tool_search_call" - "tool_search_output" - "additional_tools" - "compaction" - "program" - "program_output" - "mcp_call" - "mcp_list_tools" - "mcp_approval_request" - "mcp_approval_response" type: "string" type: "object" title: "Items" type: "array" description: "Input to the model: a string or an array of input items (messages, files, etc.)." instructions: description: "System prompt / instructions for the model." type: "string" integration_id: description: "Integration ID used to resolve provider credentials for this request." type: "string" limits: $ref: "#/components/schemas/ResponseExecutionLimits" description: "Bound agent-loop execution. Fields: max_iterations (LLM turns), max_execution_time (seconds), max_cost (USD; send 0 to disable a manifest-configured cap), max_depth (sub-agent nesting), tool_timeout (seconds). Body values override agent-manifest defaults." load_balancer: $ref: "#/components/schemas/LoadBalancerConfig" description: "Load balancing configuration for selecting among multiple models." max_output_tokens: description: "Maximum number of tokens in the response output." format: "int64" type: "integer" max_tool_calls: description: "Maximum number of tool call rounds in the agentic loop." format: "int64" type: "integer" memory: $ref: "#/components/schemas/MemoryParam" description: "Attach a memory store entity to enable persistent memory across requests. See Memory Stores documentation for setup." metadata: additionalProperties: type: "string" description: "Developer-defined key-value pairs attached to the response (OpenAI spec: Map). Non-string values are rejected with a 400." type: "object" model: description: "The model to use in provider/model format (e.g. openai/gpt-4o). Use agent/ to invoke a pre-configured agent from the orq.ai platform." type: "string" parallel_tool_calls: description: "Whether to allow parallel tool calls." type: "boolean" plugins: description: "Request-scoped transforms applied to the text exchanged with the model. Supports pii_redaction, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and response_healing, which repairs malformed JSON in non-streaming model output." items: $ref: "#/components/schemas/PublicPlugin" type: - "array" - "null" presence_penalty: description: "Penalize new tokens based on their presence in the text so far. Between -2.0 and 2.0." format: "double" type: "number" previous_response_id: description: "The ID of a previous response to continue from. Requires store to be true (default) on the original response." type: "string" prompt_cache_key: description: "Key for prompt caching across requests." type: "string" reasoning: $ref: "#/components/schemas/ReasoningParam" description: "Configure reasoning behavior. Set effort (none, minimal, low, medium, high, xhigh, max) to control how much the model thinks before answering. Higher effort means more reasoning tokens and better answers for complex tasks, at higher cost." retry: $ref: "#/components/schemas/ResponseRetryConfig" description: "Retry configuration. Specify the number of retries and which HTTP status codes should trigger a retry." safety_identifier: description: "Safety identifier for content filtering." type: "string" security: $ref: "#/components/schemas/SecurityConfig" description: "Trace masking configuration for request and response data." service_tier: description: "Processing mode for the request. Fast uses premium low-latency processing; priority remains a backward-compatible alias." enum: - "auto" - "default" - "flex" - "fast" - "scale" - "priority" type: "string" stop_sequences: description: "Custom text sequences that cause the model to stop generating. Forwarded to providers that support it (e.g. Anthropic); ignored otherwise." items: type: "string" type: "array" store: description: "Whether to persist the response (default: true). When false, the response cannot be retrieved later and previous_response_id will not work for follow-up requests." type: "boolean" stream: description: "If true, returns a stream of server-sent events." type: "boolean" stream_options: $ref: "#/components/schemas/StreamOptions" tags: description: "Tags attached to the request trace." items: type: "string" type: - "array" - "null" temperature: description: "Sampling temperature between 0 and 2." format: "double" type: "number" template_engine: description: "Template engine for variable substitution in instructions. Defaults to the agent manifest's engine when invoking an agent, otherwise text." enum: - "text" - "jinja" - "mustache" type: "string" text: description: "Configuration for text output." properties: format: anyOf: - properties: type: enum: - "text" type: "string" required: - "type" title: "Plain text" type: "object" - properties: description: description: "A description of what the response format is for, used by the model to determine how to respond in the format." type: "string" name: description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" type: "string" schema: additionalProperties: true description: "The schema for the response format, described as a JSON Schema object." type: "object" strict: description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field." type: "boolean" type: description: "The type of response format being defined. Always `json_schema`." enum: - "json_schema" type: "string" required: - "type" - "name" - "schema" title: "JSON Schema" type: "object" description: "The output format: plain text or structured JSON schema." verbosity: description: "Controls the verbosity of the model output." enum: - "low" - "medium" - "high" type: "string" type: "object" thread: $ref: "#/components/schemas/ResponseThread" description: "Thread for grouping related requests." timeout: $ref: "#/components/schemas/TimeoutConfig" description: "Provider call timeout configuration in milliseconds." tool_choice: anyOf: - description: "Shorthand: \"auto\" lets the model decide, \"none\" disables tools, \"required\" forces tool use." enum: - "auto" - "none" - "required" title: "Shorthand" type: "string" - description: "Select a specific function tool by name." properties: name: description: "The name of the function to call." type: "string" type: enum: - "function" type: "string" required: - "type" - "name" title: "Specific function" type: "object" description: "How the model should use the provided tools. Can be a string shorthand or a specific function selector." tools: description: "Tools available to the model." items: anyOf: - description: "A function tool the model can call." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" description: description: "A description of what the function does." type: "string" name: description: "The name of the function." type: "string" parameters: additionalProperties: true description: "The parameters the function accepts, as a JSON Schema object." type: "object" strict: description: "Whether to enforce strict parameter validation." type: "boolean" type: enum: - "function" type: "string" required: - "type" - "name" title: "Function" type: "object" - $ref: "#/components/schemas/OrqAdvisorTool" - $ref: "#/components/schemas/OrqSidekickTool" - description: "An orq.ai platform tool reference. For MCP tools, prefer type 'mcp' with 'key' instead of 'orq:mcp' with 'tool_id'." properties: files: description: "Files to stage in /workspace for orq:code_interpreter. Maximum 10 files." items: properties: file_id: description: "The workspace file ID." type: "string" name: description: "The file name exposed under /workspace." type: "string" required: - "file_id" - "name" type: "object" maxItems: 10 type: "array" network: description: "Network access intent for orq:code_interpreter. Stored and validated today; runtime enforcement by the sandbox egress layer is rolling out and until then sandbox executions retain default public internet egress." properties: allowlist: default: [] description: "Allowed network hostnames or IPv4 addresses when mode is allowlist. Maximum 50 entries." items: type: "string" maxItems: 50 type: "array" mode: default: "disabled" description: "Network mode. Defaults to disabled." enum: - "disabled" - "allowlist" type: "string" type: "object" tool_id: description: "The tool ID (for orq:mcp, orq:http, orq:function)." type: "string" type: description: "The orq.ai tool type." enum: - "orq:current_date" - "orq:google_search" - "orq:web_scraper" - "orq:code_interpreter" - "orq:mcp" - "orq:http" - "orq:function" type: "string" required: - "type" title: "orq.ai Tool" type: "object" - description: "An MCP (Model Context Protocol) server tool. Provide server_url for inline mode, or key to reference a pre-configured MCP server." properties: allowed_tools: description: "Filter which tools from the MCP server are exposed." properties: read_only: description: "Only expose tools with readOnlyHint annotation." type: "boolean" tool_names: description: "List of allowed tool names." items: type: "string" type: "array" type: "object" headers: additionalProperties: type: "string" description: "Custom headers to send with MCP requests. Values support {{variable}} templates." type: "object" key: description: "Unique identifier. Required for pre-configured MCP servers (lookup key). For inline servers, used as a trace/display label." type: "string" server_description: description: "Human-readable description of the server." type: "string" server_url: description: "The MCP server endpoint URL (inline mode)." type: "string" type: enum: - "mcp" type: "string" required: - "type" title: "MCP Tool" type: "object" description: "A tool definition. The \"type\" field determines the tool kind." type: "array" top_k: description: "Only sample from the top K options for each subsequent token. Forwarded to providers that support it (e.g. Anthropic); ignored otherwise." format: "int64" type: "integer" top_logprobs: description: "Number of most likely tokens to return at each position." format: "int64" type: "integer" top_p: description: "Nucleus sampling parameter." format: "double" type: "number" variables: additionalProperties: {} description: "Template variables for prompt substitution. Plain values fill {{variable}} placeholders in instructions. For secrets, use {\"secret\": true, \"value\": \"sensitive-data\"} — secrets are automatically passed to platform tools (Python, HTTP, MCP) and redacted from traces." type: "object" type: "object" PublicCreateScheduleBody: additionalProperties: false properties: agent_tag: description: "Pin this schedule to a specific agent version. Omit to always use the active version." type: "string" display_name: description: "Human-readable name of the schedule." type: "string" expression: description: "6-field cron expression (sec min hour dom month dow). Seconds and minutes must be 0, day-of-month and month must be '*'. Hour and weekday must each be a single integer or '*'; ranges, lists, steps, and named days are rejected. Accepted shapes: hourly '0 0 * * * *', daily '0 0 9 * * *' (hour 0-23), weekly '0 0 9 * * 1' (weekday 0-6). Minimum firing cadence is 1 hour." type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" description: "Invocation payload delivered to the agent on every firing." type: description: "Schedule type. Only cron is accepted; the expression must be a 6-field cron expression firing at most once per hour." enum: - "cron" type: "string" required: - "type" - "expression" - "display_name" - "payload" type: "object" PublicEmbeddingData: additionalProperties: false properties: embedding: description: "The embedding vector, which is a list of floats. The length of vector depends on the model. Can also be a base64-encoded string when encoding_format is base64." index: description: "The index of the embedding in the list of embeddings." format: "int64" type: "integer" object: description: "The object type, which is always \"embedding\"." enum: - "embedding" type: "string" required: - "object" - "index" - "embedding" type: "object" PublicEmbeddingUsage: additionalProperties: false properties: prompt_tokens: description: "The number of tokens used by the prompt." format: "int64" type: "integer" total_tokens: description: "The total number of tokens used by the request." format: "int64" type: "integer" required: - "prompt_tokens" - "total_tokens" type: "object" PublicModelEntry: additionalProperties: false properties: created: description: "Unix timestamp (seconds) when the model was added." format: "int64" type: "integer" id: description: "Model identifier in provider/model format (e.g. openai/gpt-4o)." type: "string" object: description: "Always \"model\"." enum: - "model" type: "string" owned_by: description: "The provider that owns the model (e.g. openai, anthropic)." type: "string" required: - "id" - "object" - "owned_by" - "created" type: "object" PublicPlugin: additionalProperties: false properties: entities: description: "pii_redaction only. Entity types to redact (e.g. EMAIL_ADDRESS, BSN). Omit to redact every type detected for the language." items: type: "string" type: - "array" - "null" id: description: "Plugin discriminator. pii_redaction replaces PII with placeholders before the provider sees it and restores the original values in the response. response_healing repairs malformed JSON in non-streaming model output." enum: - "pii_redaction" - "response_healing" type: "string" language: description: "pii_redaction only. Detector language. Defaults to en." enum: - "en" - "nl" type: "string" on_failure: description: "pii_redaction only. Behavior when redaction is unavailable. block (default) fails the request; passthrough sends the original text." enum: - "block" - "passthrough" type: "string" threshold: description: "pii_redaction only. Detector confidence cutoff in [0,1]." format: "double" maximum: 1 minimum: 0 type: "number" required: - "id" type: "object" PublicResponseResource: additionalProperties: false properties: background: type: "boolean" completed_at: format: "int64" type: - "integer" - "null" conversation: $ref: "#/components/schemas/ConversationParam" created_at: format: "int64" type: "integer" error: anyOf: - $ref: "#/components/schemas/ResponseError" - type: "null" frequency_penalty: format: "double" type: "number" id: type: "string" incomplete_details: anyOf: - $ref: "#/components/schemas/IncompleteDetails" - type: "null" input: description: "Array of input items (messages, function call outputs, etc.)" items: {} type: - "array" - "null" instructions: type: - "string" - "null" max_output_tokens: format: "int64" type: - "integer" - "null" max_tool_calls: format: "int64" type: - "integer" - "null" memory: $ref: "#/components/schemas/MemoryParam" metadata: additionalProperties: type: "string" description: "Developer-defined key-value pairs attached to the response (OpenAI spec: Map)." type: "object" model: type: "string" object: description: "Always \"response\"" type: "string" output: description: "Array of output items (messages, function calls, reasoning, etc.)" items: {} type: - "array" - "null" parallel_tool_calls: type: "boolean" presence_penalty: format: "double" type: "number" previous_response_id: type: - "string" - "null" prompt_cache_key: type: - "string" - "null" prompt_cache_retention: type: - "string" - "null" reasoning: anyOf: - $ref: "#/components/schemas/Reasoning" - type: "null" safety_identifier: type: - "string" - "null" service_tier: enum: - "auto" - "default" - "flex" - "fast" - "scale" - "priority" type: "string" status: enum: - "queued" - "in_progress" - "completed" - "failed" - "incomplete" type: "string" store: type: "boolean" telemetry: $ref: "#/components/schemas/Telemetry" description: "OpenTelemetry trace and span identifiers for this response." temperature: format: "double" type: "number" text: description: "Text output configuration including format and verbosity" tool_choice: description: "Tool choice setting: \"auto\", \"none\", \"required\", or a specific function" tools: description: "Array of tool configurations used in this response" items: {} type: - "array" - "null" top_k: description: "Only sample from the top K options for each subsequent token. Present only when set on the request." format: "int64" type: "integer" top_logprobs: format: "int64" type: "integer" top_p: format: "double" type: "number" truncation: enum: - "disabled" - "auto" type: "string" usage: anyOf: - $ref: "#/components/schemas/PublicUsage" - type: "null" user: type: - "string" - "null" variables: additionalProperties: {} type: "object" required: - "id" - "object" - "created_at" - "completed_at" - "status" - "incomplete_details" - "model" - "previous_response_id" - "instructions" - "input" - "output" - "error" - "tools" - "tool_choice" - "temperature" - "top_p" - "presence_penalty" - "frequency_penalty" - "top_logprobs" - "max_output_tokens" - "max_tool_calls" - "reasoning" - "text" - "user" - "usage" - "truncation" - "parallel_tool_calls" - "store" - "background" - "metadata" - "service_tier" - "safety_identifier" - "prompt_cache_key" - "prompt_cache_retention" type: "object" PublicSchedule: additionalProperties: false properties: _id: description: "ULID identifying this schedule." type: "string" agent_key: type: "string" agent_tag: description: "Pinned agent version. Omit to always run the agent's current active version." type: "string" created: format: "date-time" type: "string" created_by_id: description: "ID of the API key that created the schedule." type: "string" display_name: description: "Human-readable name of the schedule. Omitted for schedules created before display names were required." type: "string" expression: description: "6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp." type: "string" generation: description: "Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers." format: "int64" type: "integer" is_active: description: "Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing." type: "boolean" last_triggered_at: description: "Timestamp of the most recent firing, if any." format: "date-time" type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" trigger_count: description: "Total firings since creation or last expression/type change." format: "int64" type: "integer" type: description: "Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction." enum: - "cron" - "once" - "interval" type: "string" updated: format: "date-time" type: "string" updated_by_id: description: "ID of the API key that last updated the schedule. Omitted until the schedule is updated." type: "string" required: - "_id" - "agent_key" - "type" - "expression" - "is_active" - "generation" - "payload" - "created_by_id" - "created" - "updated" - "trigger_count" type: "object" PublicScheduleErrorDetail: additionalProperties: false properties: code: description: "Stable error code, e.g. invalid_expression, schedule_not_found, agent_not_found." type: "string" message: description: "Human-readable error description." type: "string" required: - "code" - "message" type: "object" PublicSchedulePayload: additionalProperties: false properties: input: description: "Input to pass to the agent on each firing. Same shape as the Responses API input — a string or an array of input items." memory_entity_id: description: "Optional memory store entity ID to attach to each run." type: "string" metadata: additionalProperties: type: "string" description: "Opaque string key/value pairs attached to every response generated by this schedule." type: "object" variables: additionalProperties: {} description: "Template variables substituted into instructions. Supports secret values: {\"secret\": true, \"value\": \"...\"}." type: "object" type: "object" PublicUpdateScheduleBody: additionalProperties: false properties: agent_tag: description: "Change the pinned agent version." type: "string" display_name: description: "Rename the schedule." type: "string" expression: description: "Update the schedule expression. Same 6-field cron shapes as create; minimum firing cadence is 1 hour." type: "string" is_active: description: "Activate or deactivate the schedule. Deactivating removes the NATS entry; activating re-publishes with current values." type: "boolean" payload: $ref: "#/components/schemas/PublicSchedulePayload" description: "Update the invocation payload. Payload-only changes do not reset the firing cadence or bump generation." type: description: "Change the schedule type. Only cron is accepted. Changing type or expression resets the NATS schedule and bumps generation." enum: - "cron" type: "string" type: "object" PublicUsage: additionalProperties: false properties: input_cost: description: "Cost (USD) of input tokens. Present when billing was computed for this response." format: "double" type: "number" input_tokens: format: "int64" type: "integer" input_tokens_details: $ref: "#/components/schemas/InputTokensDetails" output_cost: description: "Cost (USD) of output tokens. Present when billing was computed for this response." format: "double" type: "number" output_tokens: format: "int64" type: "integer" output_tokens_details: $ref: "#/components/schemas/OutputTokensDetails" total_cost: description: "Total cost (USD) of the response. Present when billing was computed for this response." format: "double" type: "number" total_tokens: format: "int64" type: "integer" web_search_requests: format: "int64" type: "integer" required: - "input_tokens" - "output_tokens" - "total_tokens" - "input_tokens_details" - "output_tokens_details" type: "object" Reasoning: additionalProperties: false properties: effort: 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." enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" - "max" type: "string" summary: description: "The format of the reasoning summary returned by the model." enum: - "concise" - "detailed" - "auto" - null type: - "string" - "null" type: "object" ReasoningParam: additionalProperties: false properties: effort: 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." enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" - "max" type: "string" summary: description: "The format of the reasoning summary returned by the model." enum: - "concise" - "detailed" - "auto" type: "string" type: "object" ResponseCodeInterpreterCallCodeDeltaStreamEvent: additionalProperties: true description: "A `response.code_interpreter_call_code.delta` server-sent event." properties: delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.code_interpreter_call_code.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "delta" title: "Code Interpreter Call Code Delta" type: "object" ResponseCodeInterpreterCallCodeDoneStreamEvent: additionalProperties: true description: "A `response.code_interpreter_call_code.done` server-sent event." properties: code: description: "The completed code interpreter code." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.code_interpreter_call_code.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "code" title: "Code Interpreter Call Code Done" type: "object" ResponseCodeInterpreterCallCompletedStreamEvent: additionalProperties: true description: "A `response.code_interpreter_call.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.code_interpreter_call.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Code Interpreter Call Completed" type: "object" ResponseCodeInterpreterCallInProgressStreamEvent: additionalProperties: true description: "A `response.code_interpreter_call.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.code_interpreter_call.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Code Interpreter Call In Progress" type: "object" ResponseCodeInterpreterCallInterpretingStreamEvent: additionalProperties: true description: "A `response.code_interpreter_call.interpreting` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.code_interpreter_call.interpreting" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Code Interpreter Call Interpreting" type: "object" ResponseCompletedStreamEvent: additionalProperties: true description: "A `response.completed` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.completed" type: "string" required: - "type" - "sequence_number" - "response" title: "Completed" type: "object" ResponseContentPartAddedStreamEvent: additionalProperties: true description: "A `response.content_part.added` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" part: additionalProperties: true description: "The content part." type: "object" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.content_part.added" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "part" title: "Content Part Added" type: "object" ResponseContentPartDoneStreamEvent: additionalProperties: true description: "A `response.content_part.done` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" part: additionalProperties: true description: "The content part." type: "object" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.content_part.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "part" title: "Content Part Done" type: "object" ResponseCreatedStreamEvent: additionalProperties: true description: "A `response.created` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.created" type: "string" required: - "type" - "sequence_number" - "response" title: "Created" type: "object" ResponseCustomToolCallInputDeltaStreamEvent: additionalProperties: true description: "A `response.custom_tool_call_input.delta` server-sent event." properties: delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.custom_tool_call_input.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "delta" title: "Custom Tool Call Input Delta" type: "object" ResponseCustomToolCallInputDoneStreamEvent: additionalProperties: true description: "A `response.custom_tool_call_input.done` server-sent event." properties: input: description: "The completed custom tool call input." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.custom_tool_call_input.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "input" title: "Custom Tool Call Input Done" type: "object" ResponseError: additionalProperties: false properties: code: type: "string" message: type: "string" required: - "code" - "message" type: "object" ResponseErrorStreamEvent: additionalProperties: true description: "A `error` server-sent event." properties: error: $ref: "#/components/schemas/ResponseError" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "error" type: "string" required: - "type" - "sequence_number" - "error" title: "Error" type: "object" ResponseExecutionLimits: additionalProperties: false properties: max_cost: format: "double" type: "number" max_depth: format: "int64" type: "integer" max_execution_time: format: "int64" type: "integer" max_iterations: format: "int64" type: "integer" tool_timeout: format: "int64" type: "integer" type: "object" ResponseFailedStreamEvent: additionalProperties: true description: "A `response.failed` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.failed" type: "string" required: - "type" - "sequence_number" - "response" title: "Failed" type: "object" ResponseFileSearchCallCompletedStreamEvent: additionalProperties: true description: "A `response.file_search_call.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.file_search_call.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "File Search Call Completed" type: "object" ResponseFileSearchCallInProgressStreamEvent: additionalProperties: true description: "A `response.file_search_call.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.file_search_call.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "File Search Call In Progress" type: "object" ResponseFileSearchCallSearchingStreamEvent: additionalProperties: true description: "A `response.file_search_call.searching` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.file_search_call.searching" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "File Search Call Searching" type: "object" ResponseFunctionCallArgumentsDeltaStreamEvent: additionalProperties: true description: "A `response.function_call_arguments.delta` server-sent event." properties: delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" obfuscation: description: "Obfuscation padding accompanying the delta, when present." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.function_call_arguments.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "delta" title: "Function Call Arguments Delta" type: "object" ResponseFunctionCallArgumentsDoneStreamEvent: additionalProperties: true description: "A `response.function_call_arguments.done` server-sent event." properties: arguments: description: "The completed function-call arguments JSON." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.function_call_arguments.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "arguments" title: "Function Call Arguments Done" type: "object" ResponseIdentity: additionalProperties: false properties: display_name: type: "string" email: type: "string" id: type: "string" metadata: items: additionalProperties: {} type: "object" type: - "array" - "null" tags: items: type: "string" type: - "array" - "null" required: - "id" type: "object" ResponseImageGenerationCallCompletedStreamEvent: additionalProperties: true description: "A `response.image_generation_call.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.image_generation_call.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Image Generation Call Completed" type: "object" ResponseImageGenerationCallGeneratingStreamEvent: additionalProperties: true description: "A `response.image_generation_call.generating` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.image_generation_call.generating" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Image Generation Call Generating" type: "object" ResponseImageGenerationCallInProgressStreamEvent: additionalProperties: true description: "A `response.image_generation_call.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.image_generation_call.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Image Generation Call In Progress" type: "object" ResponseImageGenerationCallPartialImageStreamEvent: additionalProperties: true description: "A `response.image_generation_call.partial_image` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" partial_image_b64: description: "Base64-encoded partial image." type: "string" partial_image_index: description: "Index of the partial image." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.image_generation_call.partial_image" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "partial_image_b64" - "partial_image_index" title: "Image Generation Call Partial Image" type: "object" ResponseInProgressStreamEvent: additionalProperties: true description: "A `response.in_progress` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.in_progress" type: "string" required: - "type" - "sequence_number" - "response" title: "In Progress" type: "object" ResponseIncompleteStreamEvent: additionalProperties: true description: "A `response.incomplete` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.incomplete" type: "string" required: - "type" - "sequence_number" - "response" title: "Incomplete" type: "object" ResponseMCPCallArgumentsDeltaStreamEvent: additionalProperties: true description: "A `response.mcp_call_arguments.delta` server-sent event." properties: delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_call_arguments.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "delta" title: "MCP Call Arguments Delta" type: "object" ResponseMCPCallArgumentsDoneStreamEvent: additionalProperties: true description: "A `response.mcp_call_arguments.done` server-sent event." properties: arguments: description: "The completed MCP-call arguments JSON." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_call_arguments.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "arguments" title: "MCP Call Arguments Done" type: "object" ResponseMCPCallCompletedStreamEvent: additionalProperties: true description: "A `response.mcp_call.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_call.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP Call Completed" type: "object" ResponseMCPCallFailedStreamEvent: additionalProperties: true description: "A `response.mcp_call.failed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_call.failed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP Call Failed" type: "object" ResponseMCPCallInProgressStreamEvent: additionalProperties: true description: "A `response.mcp_call.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_call.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP Call In Progress" type: "object" ResponseMCPListToolsCompletedStreamEvent: additionalProperties: true description: "A `response.mcp_list_tools.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_list_tools.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP List Tools Completed" type: "object" ResponseMCPListToolsFailedStreamEvent: additionalProperties: true description: "A `response.mcp_list_tools.failed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_list_tools.failed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP List Tools Failed" type: "object" ResponseMCPListToolsInProgressStreamEvent: additionalProperties: true description: "A `response.mcp_list_tools.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.mcp_list_tools.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "MCP List Tools In Progress" type: "object" ResponseOutputItemAddedStreamEvent: additionalProperties: true description: "A `response.output_item.added` server-sent event." properties: item: additionalProperties: true description: "The output item (message, function call, reasoning, etc.)." type: "object" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.output_item.added" type: "string" required: - "type" - "sequence_number" - "output_index" - "item" title: "Output Item Added" type: "object" ResponseOutputItemDoneStreamEvent: additionalProperties: true description: "A `response.output_item.done` server-sent event." properties: item: additionalProperties: true description: "The output item (message, function call, reasoning, etc.)." type: "object" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.output_item.done" type: "string" required: - "type" - "sequence_number" - "output_index" - "item" title: "Output Item Done" type: "object" ResponseOutputTextAnnotationAddedStreamEvent: additionalProperties: true description: "A `response.output_text.annotation.added` server-sent event." properties: annotation: additionalProperties: true description: "The annotation added to the output text." type: "object" annotation_index: description: "Index of the annotation within the content part." type: "integer" content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.output_text.annotation.added" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "annotation_index" - "annotation" title: "Output Text Annotation Added" type: "object" ResponseOutputTextDeltaStreamEvent: additionalProperties: true description: "A `response.output_text.delta` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" logprobs: description: "Log probability information for the emitted tokens." items: additionalProperties: true type: "object" type: "array" obfuscation: description: "Obfuscation padding accompanying the delta, when present." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.output_text.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "delta" - "logprobs" title: "Output Text Delta" type: "object" ResponseOutputTextDoneStreamEvent: additionalProperties: true description: "A `response.output_text.done` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" logprobs: description: "Log probability information for the emitted tokens." items: additionalProperties: true type: "object" type: "array" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" text: description: "The completed output text." type: "string" type: description: "The event type. Discriminates the payload." enum: - "response.output_text.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "text" - "logprobs" title: "Output Text Done" type: "object" ResponseQueuedStreamEvent: additionalProperties: true description: "A `response.queued` server-sent event." properties: response: $ref: "#/components/schemas/PublicResponseResource" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.queued" type: "string" required: - "type" - "sequence_number" - "response" title: "Queued" type: "object" ResponseReasoningDeltaStreamEvent: additionalProperties: true description: "A `response.reasoning.delta` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" obfuscation: description: "Obfuscation padding accompanying the delta, when present." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "delta" title: "Reasoning Delta" type: "object" ResponseReasoningDoneStreamEvent: additionalProperties: true description: "A `response.reasoning.done` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" text: description: "The completed reasoning text." type: "string" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "text" title: "Reasoning Done" type: "object" ResponseReasoningSummaryPartAddedStreamEvent: additionalProperties: true description: "A `response.reasoning_summary_part.added` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" part: additionalProperties: true description: "The reasoning summary part." type: "object" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" summary_index: description: "Index of the reasoning summary part." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_summary_part.added" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "summary_index" - "part" title: "Reasoning Summary Part Added" type: "object" ResponseReasoningSummaryPartDoneStreamEvent: additionalProperties: true description: "A `response.reasoning_summary_part.done` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" part: additionalProperties: true description: "The reasoning summary part." type: "object" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" summary_index: description: "Index of the reasoning summary part." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_summary_part.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "summary_index" - "part" title: "Reasoning Summary Part Done" type: "object" ResponseReasoningSummaryTextDeltaStreamEvent: additionalProperties: true description: "A `response.reasoning_summary_text.delta` server-sent event." properties: delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" obfuscation: description: "Obfuscation padding accompanying the delta, when present." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" summary_index: description: "Index of the reasoning summary part." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_summary_text.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "summary_index" - "delta" title: "Reasoning Summary Text Delta" type: "object" ResponseReasoningSummaryTextDoneStreamEvent: additionalProperties: true description: "A `response.reasoning_summary_text.done` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" summary_index: description: "Index of the reasoning summary part." type: "integer" text: description: "The completed reasoning summary text." type: "string" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_summary_text.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "summary_index" - "text" title: "Reasoning Summary Text Done" type: "object" ResponseReasoningTextDeltaStreamEvent: additionalProperties: true description: "A `response.reasoning_text.delta` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" obfuscation: description: "Obfuscation padding accompanying the delta, when present." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_text.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "delta" title: "Reasoning Text Delta" type: "object" ResponseReasoningTextDoneStreamEvent: additionalProperties: true description: "A `response.reasoning_text.done` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" text: description: "The completed reasoning text." type: "string" type: description: "The event type. Discriminates the payload." enum: - "response.reasoning_text.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "text" title: "Reasoning Text Done" type: "object" ResponseRefusalDeltaStreamEvent: additionalProperties: true description: "A `response.refusal.delta` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" delta: description: "Incremental text or argument chunk." type: "string" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.refusal.delta" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "delta" title: "Refusal Delta" type: "object" ResponseRefusalDoneStreamEvent: additionalProperties: true description: "A `response.refusal.done` server-sent event." properties: content_index: description: "Index of the content part within the output item." type: "integer" item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" refusal: description: "The completed refusal text." type: "string" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.refusal.done" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" - "content_index" - "refusal" title: "Refusal Done" type: "object" ResponseRetryConfig: additionalProperties: false properties: count: description: "Number of retries (1-5)." format: "int64" type: "integer" on_codes: description: "HTTP status codes that trigger a retry (e.g. [429, 500, 502, 503])." items: format: "int64" type: "integer" type: - "array" - "null" required: - "count" - "on_codes" type: "object" ResponseStreamEvent: description: "A single server-sent event emitted on the response stream. The `type` field discriminates the payload." discriminator: mapping: error: "#/components/schemas/ResponseErrorStreamEvent" response.code_interpreter_call.completed: "#/components/schemas/ResponseCodeInterpreterCallCompletedStreamEvent" response.code_interpreter_call.in_progress: "#/components/schemas/ResponseCodeInterpreterCallInProgressStreamEvent" response.code_interpreter_call.interpreting: "#/components/schemas/ResponseCodeInterpreterCallInterpretingStreamEvent" response.code_interpreter_call_code.delta: "#/components/schemas/ResponseCodeInterpreterCallCodeDeltaStreamEvent" response.code_interpreter_call_code.done: "#/components/schemas/ResponseCodeInterpreterCallCodeDoneStreamEvent" response.completed: "#/components/schemas/ResponseCompletedStreamEvent" response.content_part.added: "#/components/schemas/ResponseContentPartAddedStreamEvent" response.content_part.done: "#/components/schemas/ResponseContentPartDoneStreamEvent" response.created: "#/components/schemas/ResponseCreatedStreamEvent" response.custom_tool_call_input.delta: "#/components/schemas/ResponseCustomToolCallInputDeltaStreamEvent" response.custom_tool_call_input.done: "#/components/schemas/ResponseCustomToolCallInputDoneStreamEvent" response.failed: "#/components/schemas/ResponseFailedStreamEvent" response.file_search_call.completed: "#/components/schemas/ResponseFileSearchCallCompletedStreamEvent" response.file_search_call.in_progress: "#/components/schemas/ResponseFileSearchCallInProgressStreamEvent" response.file_search_call.searching: "#/components/schemas/ResponseFileSearchCallSearchingStreamEvent" response.function_call_arguments.delta: "#/components/schemas/ResponseFunctionCallArgumentsDeltaStreamEvent" response.function_call_arguments.done: "#/components/schemas/ResponseFunctionCallArgumentsDoneStreamEvent" response.image_generation_call.completed: "#/components/schemas/ResponseImageGenerationCallCompletedStreamEvent" response.image_generation_call.generating: "#/components/schemas/ResponseImageGenerationCallGeneratingStreamEvent" response.image_generation_call.in_progress: "#/components/schemas/ResponseImageGenerationCallInProgressStreamEvent" response.image_generation_call.partial_image: "#/components/schemas/ResponseImageGenerationCallPartialImageStreamEvent" response.in_progress: "#/components/schemas/ResponseInProgressStreamEvent" response.incomplete: "#/components/schemas/ResponseIncompleteStreamEvent" response.mcp_call.completed: "#/components/schemas/ResponseMCPCallCompletedStreamEvent" response.mcp_call.failed: "#/components/schemas/ResponseMCPCallFailedStreamEvent" response.mcp_call.in_progress: "#/components/schemas/ResponseMCPCallInProgressStreamEvent" response.mcp_call_arguments.delta: "#/components/schemas/ResponseMCPCallArgumentsDeltaStreamEvent" response.mcp_call_arguments.done: "#/components/schemas/ResponseMCPCallArgumentsDoneStreamEvent" response.mcp_list_tools.completed: "#/components/schemas/ResponseMCPListToolsCompletedStreamEvent" response.mcp_list_tools.failed: "#/components/schemas/ResponseMCPListToolsFailedStreamEvent" response.mcp_list_tools.in_progress: "#/components/schemas/ResponseMCPListToolsInProgressStreamEvent" response.output_item.added: "#/components/schemas/ResponseOutputItemAddedStreamEvent" response.output_item.done: "#/components/schemas/ResponseOutputItemDoneStreamEvent" response.output_text.annotation.added: "#/components/schemas/ResponseOutputTextAnnotationAddedStreamEvent" response.output_text.delta: "#/components/schemas/ResponseOutputTextDeltaStreamEvent" response.output_text.done: "#/components/schemas/ResponseOutputTextDoneStreamEvent" response.queued: "#/components/schemas/ResponseQueuedStreamEvent" response.reasoning.delta: "#/components/schemas/ResponseReasoningDeltaStreamEvent" response.reasoning.done: "#/components/schemas/ResponseReasoningDoneStreamEvent" response.reasoning_summary_part.added: "#/components/schemas/ResponseReasoningSummaryPartAddedStreamEvent" response.reasoning_summary_part.done: "#/components/schemas/ResponseReasoningSummaryPartDoneStreamEvent" response.reasoning_summary_text.delta: "#/components/schemas/ResponseReasoningSummaryTextDeltaStreamEvent" response.reasoning_summary_text.done: "#/components/schemas/ResponseReasoningSummaryTextDoneStreamEvent" response.reasoning_text.delta: "#/components/schemas/ResponseReasoningTextDeltaStreamEvent" response.reasoning_text.done: "#/components/schemas/ResponseReasoningTextDoneStreamEvent" response.refusal.delta: "#/components/schemas/ResponseRefusalDeltaStreamEvent" response.refusal.done: "#/components/schemas/ResponseRefusalDoneStreamEvent" response.web_search_call.completed: "#/components/schemas/ResponseWebSearchCallCompletedStreamEvent" response.web_search_call.in_progress: "#/components/schemas/ResponseWebSearchCallInProgressStreamEvent" response.web_search_call.searching: "#/components/schemas/ResponseWebSearchCallSearchingStreamEvent" propertyName: "type" oneOf: - $ref: "#/components/schemas/ResponseCreatedStreamEvent" - $ref: "#/components/schemas/ResponseQueuedStreamEvent" - $ref: "#/components/schemas/ResponseInProgressStreamEvent" - $ref: "#/components/schemas/ResponseCompletedStreamEvent" - $ref: "#/components/schemas/ResponseFailedStreamEvent" - $ref: "#/components/schemas/ResponseIncompleteStreamEvent" - $ref: "#/components/schemas/ResponseOutputItemAddedStreamEvent" - $ref: "#/components/schemas/ResponseOutputItemDoneStreamEvent" - $ref: "#/components/schemas/ResponseContentPartAddedStreamEvent" - $ref: "#/components/schemas/ResponseContentPartDoneStreamEvent" - $ref: "#/components/schemas/ResponseOutputTextDeltaStreamEvent" - $ref: "#/components/schemas/ResponseOutputTextDoneStreamEvent" - $ref: "#/components/schemas/ResponseOutputTextAnnotationAddedStreamEvent" - $ref: "#/components/schemas/ResponseRefusalDeltaStreamEvent" - $ref: "#/components/schemas/ResponseRefusalDoneStreamEvent" - $ref: "#/components/schemas/ResponseFunctionCallArgumentsDeltaStreamEvent" - $ref: "#/components/schemas/ResponseFunctionCallArgumentsDoneStreamEvent" - $ref: "#/components/schemas/ResponseReasoningDeltaStreamEvent" - $ref: "#/components/schemas/ResponseReasoningTextDeltaStreamEvent" - $ref: "#/components/schemas/ResponseReasoningDoneStreamEvent" - $ref: "#/components/schemas/ResponseReasoningTextDoneStreamEvent" - $ref: "#/components/schemas/ResponseReasoningSummaryTextDeltaStreamEvent" - $ref: "#/components/schemas/ResponseReasoningSummaryTextDoneStreamEvent" - $ref: "#/components/schemas/ResponseReasoningSummaryPartAddedStreamEvent" - $ref: "#/components/schemas/ResponseReasoningSummaryPartDoneStreamEvent" - $ref: "#/components/schemas/ResponseWebSearchCallInProgressStreamEvent" - $ref: "#/components/schemas/ResponseWebSearchCallSearchingStreamEvent" - $ref: "#/components/schemas/ResponseWebSearchCallCompletedStreamEvent" - $ref: "#/components/schemas/ResponseFileSearchCallInProgressStreamEvent" - $ref: "#/components/schemas/ResponseFileSearchCallSearchingStreamEvent" - $ref: "#/components/schemas/ResponseFileSearchCallCompletedStreamEvent" - $ref: "#/components/schemas/ResponseCodeInterpreterCallInProgressStreamEvent" - $ref: "#/components/schemas/ResponseCodeInterpreterCallInterpretingStreamEvent" - $ref: "#/components/schemas/ResponseCodeInterpreterCallCompletedStreamEvent" - $ref: "#/components/schemas/ResponseImageGenerationCallInProgressStreamEvent" - $ref: "#/components/schemas/ResponseImageGenerationCallGeneratingStreamEvent" - $ref: "#/components/schemas/ResponseImageGenerationCallCompletedStreamEvent" - $ref: "#/components/schemas/ResponseMCPCallInProgressStreamEvent" - $ref: "#/components/schemas/ResponseMCPCallCompletedStreamEvent" - $ref: "#/components/schemas/ResponseMCPCallFailedStreamEvent" - $ref: "#/components/schemas/ResponseMCPListToolsInProgressStreamEvent" - $ref: "#/components/schemas/ResponseMCPListToolsCompletedStreamEvent" - $ref: "#/components/schemas/ResponseMCPListToolsFailedStreamEvent" - $ref: "#/components/schemas/ResponseCodeInterpreterCallCodeDeltaStreamEvent" - $ref: "#/components/schemas/ResponseCodeInterpreterCallCodeDoneStreamEvent" - $ref: "#/components/schemas/ResponseMCPCallArgumentsDeltaStreamEvent" - $ref: "#/components/schemas/ResponseMCPCallArgumentsDoneStreamEvent" - $ref: "#/components/schemas/ResponseCustomToolCallInputDeltaStreamEvent" - $ref: "#/components/schemas/ResponseCustomToolCallInputDoneStreamEvent" - $ref: "#/components/schemas/ResponseImageGenerationCallPartialImageStreamEvent" - $ref: "#/components/schemas/ResponseErrorStreamEvent" title: "Response Stream Event" ResponseThread: additionalProperties: false properties: id: type: "string" tags: items: type: "string" type: - "array" - "null" required: - "id" type: "object" ResponseWebSearchCallCompletedStreamEvent: additionalProperties: true description: "A `response.web_search_call.completed` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.web_search_call.completed" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Web Search Call Completed" type: "object" ResponseWebSearchCallInProgressStreamEvent: additionalProperties: true description: "A `response.web_search_call.in_progress` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.web_search_call.in_progress" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Web Search Call In Progress" type: "object" ResponseWebSearchCallSearchingStreamEvent: additionalProperties: true description: "A `response.web_search_call.searching` server-sent event." properties: item_id: description: "ID of the output item this event refers to." type: "string" output_index: description: "Index of the output item in the response output array." type: "integer" sequence_number: description: "Monotonically increasing sequence number for ordering events." type: "integer" type: description: "The event type. Discriminates the payload." enum: - "response.web_search_call.searching" type: "string" required: - "type" - "sequence_number" - "item_id" - "output_index" title: "Web Search Call Searching" type: "object" SecurityConfig: additionalProperties: false properties: mask: items: type: "string" type: - "array" - "null" type: "object" StreamOptions: additionalProperties: false properties: include_obfuscation: type: "boolean" required: - "include_obfuscation" type: "object" ThinkingParam: additionalProperties: false properties: budget_tokens: description: "Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking where supported. Budget tokens should never exceed the max output tokens parameter. Supported by budget-based models such as Anthropic and Gemini 2.5." format: "int64" type: - "integer" - "null" thinking_level: description: "The level of thinking to use for the model. Only supported by Google AI." enum: - "minimal" - "low" - "medium" - "high" type: "string" type: description: "The thinking mode to use for the model." enum: - "enabled" - "disabled" - "adaptive" type: - "string" - "null" required: - "type" - "budget_tokens" type: "object" TimeoutConfig: additionalProperties: false properties: call_timeout: format: "int64" type: "integer" required: - "call_timeout" type: "object" AggregateLogsRequest: type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" grain: type: "string" description: "Time bucket grain: \"auto\" | \"minute\" | \"hour\" | \"day\", matching the shared\n libs/go/reporting Grain vocabulary used by the traces reporting API. Empty\n defaults to \"auto\" (grain picked from the time range)." filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" AggregateLogsResponse: type: "object" properties: object: type: "string" buckets: type: "array" items: $ref: "#/components/schemas/AggregateBucket" ListLogFacetsResponse: type: "object" properties: groups: type: "array" items: $ref: "#/components/schemas/FacetGroup" ListLogFacetValuesResponse: type: "object" properties: values: type: "array" items: $ref: "#/components/schemas/FacetValue" ListLogFieldsResponse: type: "object" properties: fields: type: "array" items: $ref: "#/components/schemas/FieldInfo" FindLogPatternsRequest: required: - "from" - "to" type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" query: type: "string" filter_operator: type: "string" filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" limit: type: "integer" description: "Maximum patterns to return. Defaults to 50." format: "int32" FindLogPatternsResponse: required: - "object" - "data" - "meta" type: "object" properties: object: type: "string" description: "Object discriminator; always \"list\"." data: type: "array" items: $ref: "#/components/schemas/LogPattern" meta: $ref: "#/components/schemas/FindLogPatternsMeta" QueryLogsRequest: required: - "from" - "to" - "oql" type: "object" properties: oql: type: "string" description: "OQL query string, e.g.\n `fetch logs | filter severity_number > 10 | filter body contains \"error\"`." limit: type: "integer" description: "Maximum rows to return; a `| limit N` pipeline command takes precedence." format: "int32" from: type: "string" format: "date-time" to: type: "string" format: "date-time" page_token: type: "string" description: "Opaque cursor for pagination." QueryLogsResponse: type: "object" properties: object: type: "string" description: "Object discriminator; always \"query\". Mirrors QueryTracesResponse." search: $ref: "#/components/schemas/SearchLogsResponse" SearchLogsRequest: type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" query: type: "string" description: "Free-text query matched against the body field (case-insensitive)." filter_operator: type: "string" description: "How to combine multiple filters: \"and\" (default) or \"or\", mirroring\n the traces filter_operator." filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" sort: type: "array" items: $ref: "#/components/schemas/TraceSort" limit: type: "integer" description: "Maximum rows to return. Defaults to 100 and is capped at 1000." format: "int32" page_token: type: "string" description: "Opaque cursor for pagination; empty or absent means the first page." SearchLogsResponse: type: "object" properties: object: type: "string" description: "Object discriminator; always \"list\". Mirrors SearchTracesResponse." data: type: "array" items: $ref: "#/components/schemas/Log" has_more: type: "boolean" next_page_token: type: "string" description: "Keyset cursor for the next page; empty when has_more is false." meta: $ref: "#/components/schemas/TraceSearchMeta" total_count: type: "string" description: "Exact match count for the full time range (cursor-independent, constant\n across pages). int64 serializes as a JSON string per protojson." GetLogResponse: type: "object" properties: log: $ref: "#/components/schemas/Log" GetLogContextRequest: required: - "from" - "to" type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" query: type: "string" filter_operator: type: "string" filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" before: type: "integer" description: "Number of matching records earlier than the anchor. Defaults to 10." format: "int32" after: type: "integer" description: "Number of matching records later than the anchor. Defaults to 10." format: "int32" oql: type: "string" description: "Optional OQL pipeline. It cannot be combined with query or filters." GetLogContextResponse: required: - "anchor" - "before" - "after" - "has_more_before" - "has_more_after" type: "object" properties: anchor: $ref: "#/components/schemas/Log" before: type: "array" items: $ref: "#/components/schemas/Log" description: "Matching records earlier than the anchor, ordered oldest to newest." after: type: "array" items: $ref: "#/components/schemas/Log" description: "Matching records later than the anchor, ordered oldest to newest." has_more_before: type: "boolean" has_more_after: type: "boolean" ListTraceLogsResponse: type: "object" properties: object: type: "string" data: type: "array" items: $ref: "#/components/schemas/Log" has_more: type: "boolean" next_page_token: type: "string" TraceFilter: type: "object" properties: field: type: "string" op: type: "string" values: type: "array" items: type: "string" AggregateBucket: type: "object" properties: timestamp: type: "string" format: "date-time" severity_counts: type: "object" additionalProperties: type: "string" description: "severity_number → count" total_count: type: "string" FacetGroup: type: "object" properties: name: type: "string" keys: type: "array" items: $ref: "#/components/schemas/FacetKey" description: "FacetGroup is one attribute family in the facet hierarchy. name is one of\n \"native\" (promoted columns), \"attribute\" (log_attributes), \"resource\"\n (resource_attributes), or \"scope\" (scope_attributes)." FacetValue: type: "object" properties: value: type: "string" count: type: "string" FieldInfo: type: "object" properties: name: type: "string" type: type: "string" LogPattern: required: - "id" - "template" - "count" - "percentage" - "first_seen" - "last_seen" - "sample_log_ids" - "severity_summary" - "service_summary" type: "object" properties: id: type: "string" description: "Stable hash of the normalized template." template: type: "string" count: type: "string" description: "Number of sampled records assigned to this pattern. This is exact when\n meta.truncated is false." percentage: type: "number" description: "Percentage of sampled records assigned to this pattern, from 0 to 100." format: "double" first_seen: type: "string" format: "date-time" last_seen: type: "string" format: "date-time" sample_log_ids: type: "array" items: type: "string" description: "A bounded set of example record identifiers; raw bodies are not repeated." severity_summary: type: "array" items: $ref: "#/components/schemas/FacetValue" description: "Top severity and service values observed inside this pattern." service_summary: type: "array" items: $ref: "#/components/schemas/FacetValue" suggested_query: type: "string" description: "Bounded literal fragment that can be sent through SearchLogs to find\n representative raw records for this normalized pattern." FindLogPatternsMeta: required: - "request_id" - "from" - "to" - "total_count" - "sampled_count" - "truncated" - "warnings" type: "object" properties: request_id: type: "string" from: type: "string" format: "date-time" to: type: "string" format: "date-time" total_count: type: "string" description: "Exact number of records matching the request before bounded sampling." sampled_count: type: "string" truncated: type: "boolean" warnings: type: "array" items: type: "string" TraceSort: type: "object" properties: field: type: "string" order: type: "string" Log: type: "object" properties: id: type: "string" trace_id: type: "string" span_id: type: "string" timestamp: type: "string" format: "date-time" observed_timestamp: type: "string" format: "date-time" severity_number: type: "integer" format: "int32" severity_text: type: "string" body: type: "string" body_is_json: type: "boolean" event_name: type: "string" dropped_attributes_count: type: "integer" format: "int32" trace_flags: type: "integer" format: "uint32" scope_name: type: "string" scope_version: type: "string" scope_attributes: type: "object" additionalProperties: type: "string" log_attributes: type: "object" additionalProperties: type: "string" resource_attributes: type: "object" additionalProperties: type: "string" service_name: type: "string" service_version: type: "string" deployment_environment: type: "string" host_name: type: "string" project_id: type: "string" description: "Log is the canonical wire representation of an otel_logs row." TraceSearchMeta: type: "object" properties: request_id: type: "string" from: type: "string" format: "date-time" to: type: "string" format: "date-time" row_count: type: "integer" format: "int32" FacetKey: type: "object" properties: key: type: "string" field: type: "string" log_count: type: "string" distinct_value_count: type: "string" top_values: type: "array" items: $ref: "#/components/schemas/FacetValue" filterable: type: "boolean" description: "FacetKey is one facetable key inside a group, with its observed volume and\n top values for the requested range. field is the name usable in filters /\n sort (e.g. \"attribute.http.method\" or \"service_name\"); it is empty when the\n key is not filterable (the scope group)." QueryReportRequest: required: - "metric" - "from" - "to" type: "object" properties: metric: enum: - "genai.requests" - "genai.tokens" - "genai.cost" - "genai.errors" - "genai.error_rate" - "genai.latency.p50" - "genai.latency.p95" - "genai.latency.p99" - "genai.ttft.avg" - "genai.ttft.p50" - "genai.ttft.p95" - "genai.evaluator.runs" - "genai.evaluator.pass_rate" - "genai.evaluator.score.avg" - "genai.guardrail.runs" - "genai.guardrail.block_rate" - "genai.guardrail.triggered" - "genai.usage" type: "string" description: "Catalogue metric to query." from: type: "string" description: "Inclusive lower bound for the report window (RFC 3339, UTC)." format: "date-time" to: type: "string" description: "Exclusive upper bound for the report window (RFC 3339, UTC)." format: "date-time" grain: enum: - "auto" - "minute" - "hour" - "day" type: "string" description: "Requested bucket grain. Use `auto` or omit the field to let the server choose based on the requested range." group_by: type: "array" items: type: "string" enum: - "project" - "identity" - "provider" - "model" - "product" - "api_key" - "status_code" - "http_status_code" - "credential_type" - "dimension" - "dimension_type" - "tag" - "agent" - "tool" - "deployment" - "evaluator" - "dataset" - "prompt" - "policy" - "conversation" - "thread" - "memory_store" - "knowledge" - "sheet" - "guardrail_origin" - "evaluator_name" - "evaluator_type" - "evaluator_version" - "result_type" - "evaluation_stage" - "guardrail_stage" - "evaluator_stage" - "guardrail_action" - "result_label" description: "Reporting dimensions to break down by. Valid dimensions depend on the selected metric." filters: type: "array" items: $ref: "#/components/schemas/Filter" description: "Up to 20 allowlisted predicates combined with AND." limit: type: "integer" description: "Maximum bucket rows returned. Defaults to 1000 and is capped at\n 5000." format: "int32" time_zone: type: "string" description: "IANA time zone applied to bucket boundaries, for example\n `America/New_York`. Response timestamps remain UTC. Empty means UTC." include_totals: type: "boolean" description: "When true, include a `totals` block aggregated across the full\n report window." mode: enum: - "timeseries" - "scalar" type: "string" description: "Value shaping. `timeseries` (default) buckets by time; `scalar` returns one aggregated row per group over the whole window, ordered by value (top list), or a single row when `group_by` is empty." sort: enum: - "desc" - "asc" type: "string" description: "Value ordering for `scalar` rows. Defaults to `desc`. Ignored for `timeseries`." QueryReportResponse: type: "object" properties: object: enum: - "report" type: "string" description: "Object discriminator for typed SDKs and JSON parsers; always `report`." request: allOf: - $ref: "#/components/schemas/QueryReportRequest" description: "The request that produced this response, parroted back so caller\n code never has to remember its own payload to interpret the result." data: type: "array" items: $ref: "#/components/schemas/DataPoint" description: "Time-ordered buckets." totals: allOf: - $ref: "#/components/schemas/Totals" description: "Totals across the whole window. Present only when\n `include_totals=true` on the request." has_more: type: "boolean" description: "Pagination contract. Always populated; currently false because the\n server caps the response at `limit` instead of issuing cursors." meta: allOf: - $ref: "#/components/schemas/ResponseMeta" description: "Diagnostic metadata." Filter: type: "object" properties: field: enum: - "project" - "identity" - "provider" - "model" - "product" - "api_key" - "status_code" - "http_status_code" - "credential_type" - "billing_billable" - "dimension" - "dimension_type" - "tag" - "agent" - "tool" - "deployment" - "evaluator" - "dataset" - "prompt" - "policy" - "conversation" - "thread" - "memory_store" - "knowledge" - "sheet" - "guardrail_origin" - "evaluator_name" - "evaluator_type" - "evaluator_version" - "result_type" - "evaluation_stage" - "guardrail_stage" - "evaluator_stage" - "guardrail_action" - "result_label" type: "string" description: "Public reporting dimension to filter on. Valid fields depend on the selected metric." op: enum: - "eq" - "neq" - "in" - "not_in" type: "string" description: "Predicate operator. `eq` and `neq` accept exactly one value; `in` and `not_in` accept 1-100 values." values: type: "array" items: type: "string" description: "Values compared against the selected field. Values are interpreted\n as public API strings, not SQL fragments." DataPoint: type: "object" properties: timestamp: type: "string" description: "Bucket start in UTC, RFC 3339. Clients that need epoch ms can call\n `Date.parse(timestamp)` or `new Date(timestamp).getTime()` —\n returning the int64 in JSON would force a string (protojson rule)\n and force callers to coerce anyway, so we ship ISO only. Unset for\n `mode=scalar` rows, which aggregate the whole window." format: "date-time" dimensions: type: "object" additionalProperties: type: "string" description: "Public breakdown labels for this bucket, keyed by group-by column.\n Empty when no group-by was requested. Empty values are omitted so\n the caller never has to special-case `\"\"`." metrics: type: "object" additionalProperties: type: "number" format: "double" description: "Metric values for this bucket. Single-metric requests carry one\n entry keyed by the requested metric name (e.g. `\"genai.cost\"` →\n `0.000495`). Bundle metrics carry one entry per field. Numbers are\n pre-rounded to 10 significant digits to avoid IEEE-754 display\n noise like `0.00009900000000000001`." Totals: type: "object" properties: metrics: type: "object" additionalProperties: type: "number" format: "double" description: "Same shape and rules as `DataPoint.metrics`, aggregated across the\n whole window." ResponseMeta: type: "object" properties: effective_grain: enum: - "minute" - "hour" - "day" type: "string" description: "Bucket grain actually applied by the planner." row_count: type: "integer" description: "Number of rows in `data`. Cheap hint for clients that paginate\n client-side; mirrors `len(data)`." format: "int32" request_id: type: "string" description: "Stable identifier for this query. Forward in support tickets so\n server logs can be correlated. Also returned in the\n `X-Request-Id` response header." currency: enum: - "USD" type: "string" description: "ISO 4217 currency code for cost fields. Always `USD` today." warnings: type: "array" items: type: "string" description: "Non-fatal warnings about the response. May contain `totals_unavailable` when totals were requested but failed." AggregateTracesRequest: type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" group_by: type: "array" items: type: "string" compute: type: "array" items: $ref: "#/components/schemas/TraceCompute" limit: type: "integer" format: "int32" filter_operator: type: "string" AggregateTracesResponse: type: "object" properties: object: type: "string" data: type: "array" items: $ref: "#/components/schemas/TraceAggregateRow" ListTraceFacetsResponse: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/TraceFacet" ListTraceFacetValuesResponse: type: "object" properties: field: type: "string" values: type: "array" items: $ref: "#/components/schemas/TraceFacetValue" has_more: type: "boolean" ListTraceFieldsResponse: type: "object" properties: data: type: "array" items: $ref: "#/components/schemas/TraceField" QueryTracesRequest: required: - "from" - "to" - "oql" type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" oql: type: "string" limit: type: "integer" format: "int32" page_token: type: "string" QueryTracesResponse: type: "object" properties: object: type: "string" search: $ref: "#/components/schemas/SearchTracesResponse" SearchTracesRequest: required: - "from" - "to" type: "object" properties: from: type: "string" format: "date-time" to: type: "string" format: "date-time" filters: type: "array" items: $ref: "#/components/schemas/TraceFilter" filter_operator: type: "string" query: type: "string" sort: type: "array" items: $ref: "#/components/schemas/TraceSort" limit: type: "integer" format: "int32" page_token: type: "string" SearchTracesResponse: type: "object" properties: object: enum: - "list" type: "string" description: "Object discriminator; always `list`." data: type: "array" items: $ref: "#/components/schemas/TraceSummary" has_more: type: "boolean" next_page_token: type: "string" meta: $ref: "#/components/schemas/TraceSearchMeta" GetTraceResponse: type: "object" properties: trace: $ref: "#/components/schemas/TraceSummary" ListTraceSpansResponse: type: "object" properties: object: type: "string" data: type: "array" items: $ref: "#/components/schemas/SpanSummary" has_more: type: "boolean" next_page_token: type: "string" GetTraceSpanResponse: type: "object" properties: span: $ref: "#/components/schemas/SpanDetail" TraceCompute: type: "object" properties: metric: type: "string" op: type: "string" TraceAggregateRow: type: "object" properties: group: type: "object" additionalProperties: type: "string" metrics: type: "object" additionalProperties: type: "number" format: "double" TraceFacet: type: "object" properties: field: type: "string" label: type: "string" type: type: "string" TraceFacetValue: type: "object" properties: value: type: "string" count: type: "integer" format: "uint32" TraceField: type: "object" properties: name: type: "string" label: type: "string" type: type: "string" scope: type: "string" match: type: "string" operators: type: "array" items: type: "string" facet: type: "boolean" sortable: type: "boolean" groupable: type: "boolean" aliases: type: "array" items: type: "string" enum_values: type: "array" items: type: "string" TraceSummary: type: "object" properties: object: enum: - "trace" type: "string" description: "Object discriminator; always `trace`." trace_id: type: "string" root_span_id: type: "string" leading_span_id: type: "string" name: type: "string" operation: type: "string" status: type: "string" started_at: type: "string" format: "date-time" ended_at: type: "string" format: "date-time" duration_ms: type: "number" format: "double" project_id: type: "string" identity_id: type: "string" session_id: type: "string" thread_id: type: "string" product: type: "string" providers: type: "array" items: type: "string" models: type: "array" items: type: "string" agent: $ref: "#/components/schemas/TraceAgent" usage: $ref: "#/components/schemas/TraceUsage" cost: $ref: "#/components/schemas/TraceCost" id: type: "string" span_id: type: "string" parent_id: type: "string" type: type: "string" context: $ref: "#/components/schemas/TraceContext" attributes: type: "object" start_time: type: "string" format: "date-time" end_time: type: "string" format: "date-time" duration: type: "number" format: "double" SpanSummary: type: "object" properties: object: type: "string" trace_id: type: "string" span_id: type: "string" parent_span_id: type: "string" name: type: "string" type: type: "string" operation: type: "string" status: type: "string" started_at: type: "string" format: "date-time" ended_at: type: "string" format: "date-time" duration_ms: type: "number" format: "double" provider: type: "string" model: type: "string" usage: $ref: "#/components/schemas/TraceUsage" cost: $ref: "#/components/schemas/TraceCost" has_detail: type: "boolean" SpanDetail: type: "object" properties: summary: $ref: "#/components/schemas/SpanSummary" attributes: type: "object" TraceAgent: type: "object" properties: id: type: "string" name: type: "string" TraceUsage: type: "object" properties: prompt_tokens: type: "integer" format: "uint32" completion_tokens: type: "integer" format: "uint32" total_tokens: type: "integer" format: "uint32" prompt_cached_tokens: type: "integer" format: "uint32" prompt_audio_tokens: type: "integer" format: "uint32" completion_reasoning_tokens: type: "integer" format: "uint32" completion_audio_tokens: type: "integer" format: "uint32" completion_accepted_prediction_tokens: type: "integer" format: "uint32" completion_rejected_prediction_tokens: type: "integer" format: "uint32" TraceCost: type: "object" properties: input: type: "number" format: "double" output: type: "number" format: "double" cache_read: type: "number" format: "double" cache_write: type: "number" format: "double" reasoning: type: "number" format: "double" web_search: type: "number" format: "double" total: type: "number" format: "double" currency: type: "string" cached: type: "number" format: "double" audio_input: type: "number" format: "double" audio_output: type: "number" format: "double" accepted_prediction: type: "number" format: "double" rejected_prediction: type: "number" format: "double" billable: type: "boolean" pricing_tier: type: "string" threshold_exceeded: type: "boolean" integration_id: type: "string" TraceContext: type: "object" properties: trace_id: type: "string" span_id: type: "string" ApiKeyRestResponse: type: object required: - id - name - workspace_id - token additionalProperties: true properties: id: type: string name: type: string workspace_id: type: string token: type: string description: Raw on create/retrieve and masked in list responses. active: type: boolean is_legacy: type: boolean source: type: string budget: type: object additionalProperties: true expiration: type: string format: date-time projects: type: array items: type: string created_by_id: type: string nullable: true updated_by_id: type: string nullable: true created: type: string format: date-time updated: type: string format: date-time consumption: type: number token_consumption: type: number requests_per_minute_consumption: type: number owner: type: object additionalProperties: true project_scope: type: object additionalProperties: true permission_mode: type: string access: type: object additionalProperties: type: string token_prefix: type: string status: type: string constraints: type: object additionalProperties: true mcp_access: type: object additionalProperties: true legacy_token_family: type: string legacy_key_id: type: string last_used_at: type: string format: date-time parameters: {} paths: /v2/evaluators: get: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "all" x-cli-group: "evals" x-cli-name: "all" operationId: "GetEvals" summary: "Get all Evaluators" parameters: - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" required: false name: "search" in: "query" - schema: type: "string" enum: - "asc" - "desc" required: false name: "sort" in: "query" - schema: type: "string" minLength: 1 required: false name: "project_id" in: "query" responses: "200": description: "Returns a list of evals" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: oneOf: - $ref: "#/components/schemas/EvaluatorResponseLlm" - $ref: "#/components/schemas/EvaluatorResponseJsonSchema" - $ref: "#/components/schemas/EvaluatorResponseHttp" - $ref: "#/components/schemas/EvaluatorResponsePython" - $ref: "#/components/schemas/EvaluatorResponseFunction" - $ref: "#/components/schemas/EvaluatorResponseRagas" - $ref: "#/components/schemas/EvaluatorResponseTypescript" discriminator: propertyName: "type" mapping: llm_eval: "#/components/schemas/EvaluatorResponseLlm" json_schema: "#/components/schemas/EvaluatorResponseJsonSchema" http_eval: "#/components/schemas/EvaluatorResponseHttp" python_eval: "#/components/schemas/EvaluatorResponsePython" function_eval: "#/components/schemas/EvaluatorResponseFunction" ragas: "#/components/schemas/EvaluatorResponseRagas" typescript_eval: "#/components/schemas/EvaluatorResponseTypescript" has_more: type: "boolean" required: - "object" - "data" - "has_more" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] post: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "create" x-cli-group: "evals" x-cli-name: "create" operationId: "CreateEval" summary: "Create an Evaluator" requestBody: content: application/json: schema: oneOf: - oneOf: - type: "object" properties: guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" description: "The type of output expected from the evaluator" type: type: "string" enum: - "llm_eval" repetitions: type: - "integer" - "null" minimum: 1 maximum: 3 prompt: type: "string" categories: type: - "array" - "null" items: type: "string" categorical_labels: type: - "array" - "null" items: type: "object" properties: value: type: "string" minLength: 1 description: type: "string" required: - "value" dataset_id: type: - "string" - "null" path: type: "string" description: "Legacy alternative to `project_id`. Storage path whose first segment names the project that owns the evaluator. Mutually exclusive with `project_id`." example: "Default" project_id: type: "string" minLength: 1 description: "Unique identifier of the project that owns the evaluator, as returned by `GET /v2/projects`. Mutually exclusive with `path`." example: "01JMDPA3QW5C1V0NJ1PW34T4E5" description: type: "string" default: "" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" mode: type: "string" enum: - "single" model: type: "string" required: - "type" - "prompt" - "key" - "mode" - "model" title: "LLM" - type: "object" properties: guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" description: "The type of output expected from the evaluator" type: type: "string" enum: - "llm_eval" repetitions: type: - "integer" - "null" minimum: 1 maximum: 3 prompt: type: "string" categories: type: - "array" - "null" items: type: "string" categorical_labels: type: - "array" - "null" items: type: "object" properties: value: type: "string" minLength: 1 description: type: "string" required: - "value" dataset_id: type: - "string" - "null" path: type: "string" description: "Legacy alternative to `project_id`. Storage path whose first segment names the project that owns the evaluator. Mutually exclusive with `project_id`." example: "Default" project_id: type: "string" minLength: 1 description: "Unique identifier of the project that owns the evaluator, as returned by `GET /v2/projects`. Mutually exclusive with `path`." example: "01JMDPA3QW5C1V0NJ1PW34T4E5" description: type: "string" default: "" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" mode: type: "string" enum: - "jury" jury: type: "object" properties: judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" minItems: 2 replacement_judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" default: [] min_successful_judges: type: "integer" minimum: 2 default: 2 tie_value: type: "string" enum: - "Tie" default: "Tie" required: - "judges" required: - "type" - "prompt" - "key" - "mode" - "jury" title: "LLM Jury" - type: "object" properties: guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "number" code: type: "string" type: type: "string" enum: - "python_eval" path: type: "string" description: "Legacy alternative to `project_id`. Storage path whose first segment names the project that owns the evaluator. Mutually exclusive with `project_id`." example: "Default" project_id: type: "string" minLength: 1 description: "Unique identifier of the project that owns the evaluator, as returned by `GET /v2/projects`. Mutually exclusive with `path`." example: "01JMDPA3QW5C1V0NJ1PW34T4E5" description: type: "string" default: "" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" required: - "code" - "type" - "key" title: "Python" responses: "200": description: "Successfully created an evaluator" content: application/json: schema: oneOf: - $ref: "#/components/schemas/EvaluatorResponseLlm" - $ref: "#/components/schemas/EvaluatorResponseJsonSchema" - $ref: "#/components/schemas/EvaluatorResponseHttp" - $ref: "#/components/schemas/EvaluatorResponsePython" - $ref: "#/components/schemas/EvaluatorResponseFunction" - $ref: "#/components/schemas/EvaluatorResponseRagas" - $ref: "#/components/schemas/EvaluatorResponseTypescript" discriminator: propertyName: "type" mapping: llm_eval: "#/components/schemas/EvaluatorResponseLlm" json_schema: "#/components/schemas/EvaluatorResponseJsonSchema" http_eval: "#/components/schemas/EvaluatorResponseHttp" python_eval: "#/components/schemas/EvaluatorResponsePython" function_eval: "#/components/schemas/EvaluatorResponseFunction" ragas: "#/components/schemas/EvaluatorResponseRagas" typescript_eval: "#/components/schemas/EvaluatorResponseTypescript" "403": description: "Domain is not allowed" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/evaluators/{id}: get: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "get" x-cli-group: "evals" x-cli-name: "get" operationId: "GetEval" summary: "Retrieve an Evaluator" description: "Retrieve a single evaluator by its unique identifier. Returns the evaluator exactly as stored, including its type-specific configuration — prompt and model for LLM evaluators, source code for Python and TypeScript evaluators, the JSON Schema for schema evaluators, and so on.\n\nUse this when you already know the evaluator id (for example to refresh the state of a resource you manage declaratively). To discover evaluator ids, list them with `GET /v2/evaluators`.\n\nThis endpoint returns the stored record, which carries more detail than the representation `GET /v2/evaluators` returns: `display_name` rather than `key`, `model` as an object rather than a provider-qualified string, plus the `owner`, `domain_id`, `metadata`, `enabled` and `output_type` fields." parameters: - schema: type: "string" description: "Unique identifier of the evaluator, as returned in the `_id` field by `GET /v2/evaluators`." example: "01JMDPA3QW5C1V0NJ1PW34T4E5" required: true description: "Unique identifier of the evaluator, as returned in the `_id` field by `GET /v2/evaluators`." name: "id" in: "path" responses: "200": description: "The evaluator. The response shape depends on the evaluator `type`." content: application/json: schema: oneOf: - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" description: "The type of output expected from the evaluator" type: type: "string" enum: - "llm_eval" mode: type: - "string" - "null" enum: - "single" - "jury" - null repetitions: type: - "integer" - "null" minimum: 1 maximum: 3 model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" model_parameters: type: "object" properties: temperature: type: "number" max_tokens: type: "number" top_k: type: "number" top_p: type: "number" frequency_penalty: type: "number" presence_penalty: type: "number" reasoning_effort: type: "string" budget_tokens: type: "number" required: - "id" jury: type: - "object" - "null" properties: judges: type: "array" items: type: "object" properties: model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" model_parameters: type: "object" properties: temperature: type: "number" max_tokens: type: "number" top_k: type: "number" top_p: type: "number" frequency_penalty: type: "number" presence_penalty: type: "number" reasoning_effort: type: "string" budget_tokens: type: "number" required: - "id" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" model_parameters: type: "object" properties: temperature: type: "number" max_tokens: type: "number" top_k: type: "number" top_p: type: "number" frequency_penalty: type: "number" presence_penalty: type: "number" reasoning_effort: type: "string" budget_tokens: type: "number" required: - "id" required: - "model" default: [] required: - "model" minItems: 2 replacement_judges: type: "array" items: type: "object" properties: model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" model_parameters: type: "object" properties: temperature: type: "number" max_tokens: type: "number" top_k: type: "number" top_p: type: "number" frequency_penalty: type: "number" presence_penalty: type: "number" reasoning_effort: type: "string" budget_tokens: type: "number" required: - "id" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" model_parameters: type: "object" properties: temperature: type: "number" max_tokens: type: "number" top_k: type: "number" top_p: type: "number" frequency_penalty: type: "number" presence_penalty: type: "number" reasoning_effort: type: "string" budget_tokens: type: "number" required: - "id" required: - "model" default: [] required: - "model" default: [] min_successful_judges: type: "integer" minimum: 2 default: 2 tie_value: type: "string" enum: - "Tie" default: "Tie" required: - "judges" prompt: type: "string" categories: type: - "array" - "null" items: type: "string" categorical_labels: type: - "array" - "null" items: type: "object" properties: value: type: "string" minLength: 1 description: type: "string" required: - "value" dataset_id: type: - "string" - "null" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "type" - "prompt" title: "LLM" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" type: type: "string" enum: - "function_eval" function_params: oneOf: - type: "object" properties: type: type: "string" enum: - "contains" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "contains_none" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_all" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_any" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "contains_email" required: - "type" - type: "object" properties: type: type: "string" enum: - "contains_url" required: - "type" - type: "object" properties: type: type: "string" enum: - "contains_valid_link" required: - "type" - type: "object" properties: type: type: "string" enum: - "start_with" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "ends_with" value: type: "string" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "exact_match" required: - "type" - type: "object" properties: type: type: "string" enum: - "length_less_than" value: type: "number" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "length_between" min: type: "number" max: type: "number" required: - "type" - "min" - "max" - type: "object" properties: type: type: "string" enum: - "length_greater_than" value: type: "number" required: - "type" - "value" - type: "object" properties: type: type: "string" enum: - "one_line" required: - "type" - type: "object" properties: type: type: "string" enum: - "regex" pattern: type: "string" required: - "type" - "pattern" - type: "object" properties: type: type: "string" enum: - "is_valid_json" required: - "type" - type: "object" properties: type: type: "string" enum: - "moderations_openai" required: - "type" - type: "object" properties: type: type: "string" enum: - "moderations_google" required: - "type" - type: "object" properties: type: type: "string" enum: - "bert_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "bleu_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "rouge_n" required: - "type" - type: "object" properties: type: type: "string" enum: - "meteor_score" required: - "type" - type: "object" properties: type: type: "string" enum: - "cosine_similarity" required: - "type" - type: "object" properties: type: type: "string" enum: - "levenshtein_distance" required: - "type" - type: "object" properties: type: type: "string" enum: - "keywords_match" keywords: type: "array" items: type: "string" required: - "type" - "keywords" - type: "object" properties: type: type: "string" enum: - "most_repeated_words" required: - "type" - type: "object" properties: type: type: "string" enum: - "flesch_reading_ease" required: - "type" - type: "object" properties: type: type: "string" enum: - "gse_english_level" required: - "type" - type: "object" properties: type: type: "string" enum: - "words_count" required: - "type" - type: "object" properties: type: type: "string" enum: - "sentences_count" required: - "type" - type: "object" properties: type: type: "string" enum: - "lexical_repetition" required: - "type" - type: "object" properties: type: type: "string" enum: - "grammar_diversity" required: - "type" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "output_type" - "type" - "function_params" title: "Function" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "number" type: type: "string" enum: - "ragas" model: type: "object" properties: id: type: "string" integration_id: type: - "string" - "null" required: - "id" ragas_metric: type: "string" enum: - "context_precision" - "context_recall" - "context_entities_recall" - "harmfulness" - "maliciousness" - "coherence" - "correctness" - "conciseness" - "response_relevancy" - "faithfulness" - "summarization" - "noise_sensitivity" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "type" - "model" - "ragas_metric" title: "Ragas" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" type: type: "string" enum: - "json_schema" schema: type: "string" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "type" - "schema" title: "JSON" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" description: "The type of output expected from the evaluator" type: type: "string" enum: - "http_eval" url: type: "string" method: type: "string" enum: - "GET" - "POST" headers: type: "object" additionalProperties: type: "string" payload: type: "object" additionalProperties: {} required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "type" - "url" - "method" - "headers" - "payload" title: "HTTP" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "number" code: type: "string" type: type: "string" enum: - "python_eval" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "code" - "type" title: "Python" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" - "categorical" - "number" - "string" description: "The type of output expected from the evaluator" code: type: "string" type: type: "string" enum: - "typescript_eval" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "code" - "type" title: "Typescript" - type: "object" properties: enabled: type: "boolean" default: true metadata: type: "object" properties: required_model_with_tools_support: type: "boolean" required_retrieval_context: type: "boolean" required_expected_output: type: "boolean" supported_on_input_type: type: "boolean" supported_on_output_type: type: "boolean" support_use_as_guardrail: type: "boolean" _id: type: "string" display_name: type: "string" description: type: "string" owner: type: "string" created: type: "string" default: "2026-08-07T14:35:53.582Z" updated: type: "string" default: "2026-08-07T14:35:53.582Z" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" domain_id: type: "string" project_id: type: "string" description: "Unique identifier of the project owning this evaluator." guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" output_type: type: "string" enum: - "boolean" type: type: "string" enum: - "bedrock_eval" guardrail_identifier: type: "string" minLength: 1 guardrail_version: type: "string" minLength: 1 default: "DRAFT" guardrail_region: type: "string" minLength: 1 integration_id: type: - "string" - "null" required: - "metadata" - "_id" - "display_name" - "description" - "owner" - "domain_id" - "type" - "guardrail_identifier" title: "Bedrock Guardrail" "404": description: "No evaluator with this id exists in the authenticated workspace, or the request carries no workspace." content: application/json: schema: type: "object" properties: message: type: "string" example: "Evaluator not found" required: - "message" security: - ApiKey: [] patch: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "update" x-cli-group: "evals" x-cli-name: "update" operationId: "UpdateEval" summary: "Update an Evaluator" parameters: - schema: type: "string" required: true name: "id" in: "path" requestBody: content: application/json: schema: type: "object" properties: type: type: "string" description: "Evaluator type. Optional on update — inferred from existing evaluator." path: type: "string" description: "Legacy alternative to `project_id`. Project path. Optional on update — the evaluator keeps its current project when both are omitted. Mutually exclusive with `project_id`." example: "Default" project_id: type: "string" minLength: 1 description: "Unique identifier of the project that owns the evaluator, as returned by `GET /v2/projects`. Optional on update — the evaluator keeps its current project when omitted; supplying a different id moves it. Mutually exclusive with `path`." example: "01JMDPA3QW5C1V0NJ1PW34T4E5" key: type: "string" minLength: 1 pattern: "^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$" description: type: "string" prompt: type: "string" output_type: type: "string" categories: type: - "array" - "null" items: type: "string" categorical_labels: type: - "array" - "null" items: type: "object" properties: value: type: "string" minLength: 1 description: type: "string" required: - "value" dataset_id: type: - "string" - "null" repetitions: type: "number" mode: type: "string" enum: - "single" - "jury" model: type: "string" jury: type: "object" properties: judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" minItems: 2 replacement_judges: type: "array" items: type: "object" properties: model: type: "string" retry: type: "object" properties: count: type: "integer" minimum: 1 maximum: 5 default: 2 on_codes: type: "array" items: type: "integer" minimum: 100 maximum: 599 minItems: 1 default: - 429 - 500 - 502 - 503 - 504 fallbacks: type: "array" items: type: "object" properties: model: type: "string" required: - "model" default: [] required: - "model" default: [] min_successful_judges: type: "integer" minimum: 2 default: 2 tie_value: type: "string" enum: - "Tie" default: "Tie" required: - "judges" schema: type: "string" url: type: "string" method: type: "string" headers: type: "object" additionalProperties: type: "string" payload: type: "object" additionalProperties: {} code: type: "string" guardrail_config: anyOf: - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "boolean" value: type: "boolean" required: - "type" - "value" title: "Boolean" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "categorical" values: type: "array" items: type: "string" minLength: 1 required: - "type" - "values" title: "Categorical" - type: "object" properties: enabled: type: "boolean" default: true alert_on_failure: type: "boolean" default: false type: type: "string" enum: - "number" value: type: "number" operator: type: "string" enum: - "eq" - "ne" - "gt" - "gte" - "lt" - "lte" required: - "type" - "value" - "operator" title: "Number" - type: "null" x-speakeasy-type-override: "any" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" responses: "200": description: "Successfully updated an eval" content: application/json: schema: oneOf: - $ref: "#/components/schemas/EvaluatorResponseLlm" - $ref: "#/components/schemas/EvaluatorResponseJsonSchema" - $ref: "#/components/schemas/EvaluatorResponseHttp" - $ref: "#/components/schemas/EvaluatorResponsePython" - $ref: "#/components/schemas/EvaluatorResponseFunction" - $ref: "#/components/schemas/EvaluatorResponseRagas" - $ref: "#/components/schemas/EvaluatorResponseTypescript" discriminator: propertyName: "type" mapping: llm_eval: "#/components/schemas/EvaluatorResponseLlm" json_schema: "#/components/schemas/EvaluatorResponseJsonSchema" http_eval: "#/components/schemas/EvaluatorResponseHttp" python_eval: "#/components/schemas/EvaluatorResponsePython" function_eval: "#/components/schemas/EvaluatorResponseFunction" ragas: "#/components/schemas/EvaluatorResponseRagas" typescript_eval: "#/components/schemas/EvaluatorResponseTypescript" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] delete: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "delete" x-cli-group: "evals" x-cli-name: "delete" operationId: "DeleteEval" summary: "Delete an Evaluator" parameters: - schema: type: "string" required: true name: "id" in: "path" responses: "204": description: "Eval deleted" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" "409": description: "The evaluator is still referenced as an evaluator or guardrail by one or more deployments" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/evaluators/{id}/invoke: post: tags: - "Evals" x-speakeasy-group: "evals" x-speakeasy-name-override: "invoke" x-cli-group: "evals" x-cli-name: "invoke" operationId: "InvokeEval" summary: "Invoke a Custom Evaluator" parameters: - schema: type: "string" description: "Evaluator ID" required: true description: "Evaluator ID" name: "id" in: "path" requestBody: content: application/json: schema: type: "object" properties: query: type: "string" description: "Latest user message" output: type: "string" description: "The generated response from the model" reference: type: "string" description: "The reference used to compare the output" retrievals: type: "array" items: type: "string" description: "Knowledge base retrievals" 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" description: "The messages used to generate the output, without the last user message" model: type: "string" description: "Model to use for LLM-based evaluators (e.g. \"openai/gpt-4o\")" variables: $ref: "#/components/schemas/EvaluatorVariables" responses: "200": description: "Returns the result of the evaluator run" content: application/json: schema: oneOf: - type: "object" properties: type: type: "string" enum: - "string" original_value: type: - "string" - "null" value: type: - "string" - "null" trace_id: type: "string" span_id: type: "string" required: - "type" title: "String" - type: "object" properties: type: type: "string" enum: - "number" original_value: type: - "number" - "null" value: type: - "number" - "null" format_options: anyOf: - type: "object" properties: significant_digits: type: "number" required: - "significant_digits" - type: "object" properties: style: type: "string" enum: - "currency" currency: type: "string" enum: - "USD" required: - "style" - "currency" trace_id: type: "string" span_id: type: "string" required: - "type" - "value" title: "Number" - type: "object" properties: type: type: "string" enum: - "boolean" value: anyOf: - type: "boolean" - type: "string" - type: "number" - type: "null" trace_id: type: "string" span_id: type: "string" required: - "type" - "value" title: "Boolean" - type: "object" properties: type: type: "string" enum: - "string_array" values: type: "array" items: type: - "string" - "null" trace_id: type: "string" span_id: type: "string" required: - "type" - "values" title: "String Array" - type: "object" properties: type: type: "string" enum: - "rouge_n" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" trace_id: type: "string" span_id: type: "string" required: - "type" - "value" title: "Rouge N" - type: "object" properties: type: type: "string" enum: - "bert_score" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" trace_id: type: "string" span_id: type: "string" required: - "type" - "value" title: "BERT Score" - type: "object" properties: type: type: "string" enum: - "llm_evaluator" value: type: - "object" - "null" properties: workflow_run_id: type: - "string" - "null" trace_id: type: "string" span_id: type: "string" value: anyOf: - type: "number" - type: "boolean" - type: "string" - type: "null" explanation: type: - "string" - "null" original_value: anyOf: - type: "number" - type: "boolean" - type: "string" - type: "null" original_explanation: type: - "string" - "null" jury: type: "object" properties: judges_configured: type: "integer" minimum: 0 judges_succeeded: type: "integer" minimum: 0 judges_failed: type: "integer" minimum: 0 replacements_used: type: "integer" minimum: 0 tie: type: "boolean" votes: type: "array" items: type: "object" properties: model: type: "string" replacement: type: "boolean" success: type: "boolean" value: anyOf: - type: "number" - type: "boolean" - type: "string" explanation: type: "string" error: type: "string" required: - "model" - "replacement" - "success" stats: type: "object" properties: mean: type: "number" std: type: "number" required: - "mean" - "std" required: - "judges_configured" - "judges_succeeded" - "judges_failed" - "replacements_used" - "tie" - "votes" required: - "value" required: - "type" - "value" title: "LLM" - type: "object" properties: type: type: "string" enum: - "http_eval" value: type: - "object" - "null" properties: type: type: "string" value: anyOf: - type: "number" - type: "boolean" required: - "type" - "value" trace_id: type: "string" span_id: type: "string" required: - "type" title: "HTTP" - type: "object" properties: type: type: "string" enum: - "structured" value: type: "object" additionalProperties: {} trace_id: type: "string" span_id: type: "string" required: - "type" - "value" title: "Structured" "400": description: "Bad request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" "500": description: "Error running the evaluator" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/evaluators/{id}/versions: get: tags: - "Evals" x-cli-group: "evals" x-cli-name: "listVersions" x-speakeasy-name-override: "listVersions" summary: "List evaluator versions" description: "Returns version history for a specific evaluator" parameters: - schema: type: "string" required: true name: "id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Evaluator versions retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" created_at: type: "string" updated_at: type: "string" created_by_id: type: "string" updated_by_id: type: "string" version: type: "string" description: type: "string" checksum: type: "string" entityType: type: "string" entityId: type: "string" data: type: "object" additionalProperties: {} workspace_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "version" - "checksum" - "entityType" - "entityId" - "data" - "workspace_id" has_more: type: "boolean" required: - "object" - "data" - "has_more" "404": description: "Evaluator not found" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/deployments/invoke: post: tags: - "Deployments" x-speakeasy-group: "deployments" x-speakeasy-name-override: "invoke" x-cli-group: "deployments" x-cli-name: "invoke" operationId: "DeploymentInvoke" description: "Invoke a deployment with a given payload" summary: "Invoke" 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" - "moonshotai" - "zai" - "minimax" - "xai" - "alibaba" - "tensorix" - "scaleway" - "hcompany" - "inceptron" - "wafer" - "poolside" - "tencent" - "nebius" - "fireworks" - "baseten" - "reson8" - "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" security: - ApiKey: [] /v2/deployments: get: tags: - "Deployments" x-speakeasy-group: "deployments" x-speakeasy-name-override: "list" x-cli-group: "deployments" x-cli-name: "list" operationId: "Deployments" description: "Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first." summary: "List all deployments" parameters: - 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" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "List all deployments" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: id: type: "string" format: "uuid" description: "Unique identifier for the object." created: type: "string" description: "Date in ISO 8601 format at which the object was created." updated: type: "string" description: "Date in ISO 8601 format at which the object was last updated." key: type: "string" description: "The deployment unique key" description: type: "string" description: "An arbitrary string attached to the object. Often useful for displaying to users." prompt_config: type: "object" properties: 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. \n\n Omitting `parameters` defines a function with an empty parameter list." required: - "name" - "parameters" required: - "type" - "function" - type: "object" properties: id: type: "number" model: type: "string" model_type: type: "string" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "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" required: - "role" - "content" required: - "tools" - "model" - "model_type" - "model_parameters" - "provider" - "messages" version: type: "string" description: "THe version of the deployment" required: - "id" - "created" - "updated" - "key" - "description" - "prompt_config" - "version" has_more: type: "boolean" required: - "object" - "data" - "has_more" "500": description: "Internal Server Error" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] /v2/deployments/get_config: post: tags: - "Deployments" x-speakeasy-group: "deployments" x-speakeasy-name-override: "getConfig" x-cli-group: "deployments" x-cli-name: "getConfig" operationId: "DeploymentGetConfig" description: "Retrieve the deployment configuration" summary: "Get config" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" 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. \n\n 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." security: - ApiKey: [] /v2/deployments/stream: post: tags: - "Deployments" x-speakeasy-group: "deployments" x-speakeasy-name-override: "stream" x-cli-group: "deployments" x-cli-name: "stream" operationId: "DeploymentStream" description: "Stream deployment generation. Only supported for completions and chat completions." summary: "Stream" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "Successful operation" content: text/event-stream: schema: type: "object" properties: data: 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 - moonshotai - zai - minimax - xai - alibaba - tensorix - scaleway - hcompany - inceptron - wafer - poolside - tencent - nebius - fireworks - baseten - reson8 - 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 x-speakeasy-sse-sentinel: "[DONE]" security: - ApiKey: [] /v2/agents: post: tags: - "Agents" x-speakeasy-group: "agents" x-speakeasy-name-override: "create" x-cli-group: "agents" x-cli-name: "create" x-speakeasy-max-method-params: 17 operationId: "CreateAgentRequest" summary: "Create agent" description: "Creates a new agent with the specified configuration, including model selection, instructions, tools, and knowledge bases. Agents are intelligent assistants that can execute tasks, interact with tools, and maintain context through memory stores. The agent can be configured with a primary model and optional fallback models for automatic failover, custom instructions for behavior control, and various settings to control execution limits and tool usage." requestBody: required: true content: application/json: schema: type: "object" properties: key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "Unique identifier for the agent within the workspace" display_name: type: "string" maxLength: 255 description: "agent display name within the workspace" role: type: "string" minLength: 1 description: "The role or function of the agent" description: type: "string" minLength: 1 description: "A brief description of what the agent does" instructions: type: "string" description: "Detailed instructions that guide the agent's behavior" system_prompt: type: - "string" - "null" minLength: 1 description: "A custom system prompt template for the agent. If omitted, the default template is used." path: type: "string" description: "The path where the agent will be stored in the project structure. The first element identifies the project, followed by nested folders (auto-created as needed).\n\nWith project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key." example: "Default" model: anyOf: - type: "string" description: "\n\nA model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). The agent can be run with a wide range of models with different capabilities, performance characteristics, and price points. Only models that support tool calling (function_calling) can be used to run agents. See (supported models)[/docs/proxy/supported-models] documentation for the complete list of available models." - type: "object" properties: id: type: "string" description: "A model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). Only models that support tool calling can be used with agents." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Retries are triggered for specific HTTP status codes (e.g., 500, 429, 502, 503, 504). Supports configurable retry count (1-5) and custom status codes." required: - "id" description: "\n\nModel configuration with parameters and retry settings." title: "Model Configuration" description: "Model configuration for agent execution. Can be a simple model ID string or a configuration object with optional behavior parameters and retry settings." fallback_models: type: "array" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models used when the primary model fails. Fallbacks are attempted in order. All models must support tool calling." settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: type: "array" items: $ref: "#/components/schemas/AgentToolInputCRUD" default: [] description: "Tools available to the agent. Built-in tools only need a type, while custom tools (http, code, function) must reference pre-created tools by key or id." 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" description: "Configuration settings for the agent's behavior" memory_stores: type: "array" items: type: "string" default: [] description: "Optional array of memory store identifiers for the agent to access. Accepts both memory store IDs and keys." knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" default: [] description: "Optional array of knowledge base configurations for the agent to access" team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] title: "Team of agents" description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: - "array" - "null" items: type: "string" description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." variables: type: "object" additionalProperties: {} source: type: "string" enum: - "internal" - "external" - "experiment" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" required: - "key" - "role" - "description" - "instructions" - "path" - "model" - "settings" responses: "201": description: "Agent successfully created and ready for use. Returns the complete agent manifest including the generated ID, configuration, and all settings." content: application/json: schema: type: "object" properties: _id: type: "string" key: type: "string" pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "Unique identifier for the agent within the workspace" display_name: type: "string" project_id: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" description: "The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." version: type: "string" description: "Current semantic version of the agent manifest." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" memory_stores: type: "array" items: type: "string" default: [] description: "Array of memory store identifiers. Accepts both memory store IDs and keys." team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: "array" items: type: "string" default: [] description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." metrics: type: "object" properties: total_cost: type: "number" minimum: 0 default: 0 default: total_cost: 0 variables: type: "object" additionalProperties: {} description: "Extracted variables from agent instructions" knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" description: "Agent knowledge bases reference" source: type: "string" enum: - "internal" - "external" - "experiment" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" type: type: "string" enum: - "internal" - "a2a" default: "internal" description: "Agent type: internal (Orquesta-managed) or a2a (external A2A-compliant)" role: type: "string" minLength: 1 description: type: "string" system_prompt: type: - "string" - "null" minLength: 1 instructions: type: "string" settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: 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" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" default: [] 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" default: max_execution_time: 600 max_iterations: 100 max_cost: 0 tool_approval_required: "respect_tool" tools: [] model: type: "object" properties: id: type: "string" description: "The database ID of the primary model" integration_id: type: - "string" - "null" description: "Optional integration ID for custom model configurations" parameters: type: - "object" - "null" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors)." fallback_models: type: - "array" - "null" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models (string IDs or config objects) that will be used automatically in order if the primary model fails" required: - "id" required: - "_id" - "key" - "project_id" - "status" - "path" - "role" - "description" - "instructions" - "model" "409": description: "An agent with the same key already exists in this workspace." security: - ApiKey: [] get: tags: - "Agents" x-speakeasy-group: "agents" x-speakeasy-name-override: "list" x-cli-group: "agents" x-cli-name: "list" x-speakeasy-max-method-params: 4 operationId: "ListAgents" summary: "List agents" description: "Retrieves a comprehensive list of agents configured in your workspace. Supports pagination for large datasets and returns agents sorted by creation date (newest first). Each agent in the response includes its complete configuration: model settings with fallback options, instructions, tools, knowledge bases, memory stores, and execution parameters. Use pagination parameters to efficiently navigate through large collections of agents." parameters: - schema: type: "number" minimum: 1 maximum: 200 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200. When not provided, returns all agents without pagination." required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200. When not provided, returns all agents without pagination." name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" enum: - "internal" description: "Filter agents by type" required: false description: "Filter agents by type" name: "type" in: "query" responses: "200": description: "Successfully retrieved the list of agents. Returns a paginated response containing agent manifests with complete configurations, including primary and fallback models, tools, knowledge bases, and execution settings." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" key: type: "string" pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "Unique identifier for the agent within the workspace" display_name: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" description: "The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." version: type: "string" description: "Current semantic version of the agent manifest." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" memory_stores: type: "array" items: type: "string" default: [] description: "Array of memory store identifiers. Accepts both memory store IDs and keys." team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: "array" items: type: "string" default: [] description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." metrics: type: "object" properties: total_cost: type: "number" minimum: 0 default: 0 default: total_cost: 0 variables: type: "object" additionalProperties: {} description: "Extracted variables from agent instructions" knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" description: "Agent knowledge bases reference" source: type: "string" enum: - "internal" - "external" - "experiment" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" type: type: "string" enum: - "internal" - "a2a" default: "internal" description: "Agent type: internal (Orquesta-managed) or a2a (external A2A-compliant)" role: type: "string" minLength: 1 description: type: "string" system_prompt: type: - "string" - "null" minLength: 1 instructions: type: "string" settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: 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" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" default: [] 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" default: max_execution_time: 600 max_iterations: 100 max_cost: 0 tool_approval_required: "respect_tool" tools: [] model: type: "object" properties: id: type: "string" description: "The database ID of the primary model" integration_id: type: - "string" - "null" description: "Optional integration ID for custom model configurations" parameters: type: - "object" - "null" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors)." fallback_models: type: - "array" - "null" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models (string IDs or config objects) that will be used automatically in order if the primary model fails" required: - "id" required: - "_id" - "key" - "status" - "path" - "role" - "description" - "instructions" - "model" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] /v2/agents/{agent_key}/responses: post: tags: - "Agents" deprecated: true x-speakeasy-group: "agents.responses" x-speakeasy-name-override: "create" x-speakeasy-max-method-params: 13 x-cli-group: "agents-responses" x-cli-name: "create" x-code-samples: - lang: "curl" label: "cURL" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/agents/customer_support/responses' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"message\": {\n \"role\": \"user\",\n \"parts\": [\n {\n \"kind\": \"text\",\n \"text\": \"Hi! I am testing your capabilities. Can you describe what you can do?\"\n }\n ]\n }\n }'" - lang: "python" label: "Python" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(\n api_key=os.environ.get(\"ORQ_API_KEY\")\n)\n\nresponse = client.agents.responses.create(\n agent_key=\"customer_support\",\n message={\n \"role\": \"user\",\n \"parts\": [\n {\n \"kind\": \"text\",\n \"text\": \"Hi! I am testing your capabilities. Can you describe what you can do?\"\n }\n ]\n }\n)\n\nprint(response.output[0].parts[0].text)\nprint(response.usage)" - lang: "typescript" label: "Node.js" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst response = await client.agents.responses.create({\n agentKey: 'customer_support',\n message: {\n role: 'user',\n parts: [\n {\n kind: 'text',\n text: 'Hi! I am testing your capabilities. Can you describe what you can do?',\n },\n ],\n }\n});\n\nconsole.log(response.output[0].parts[0].text);\nconsole.log(response.usage);" operationId: "CreateAgentResponseRequest" summary: "Create response" description: "Initiates an agent conversation and returns a complete response. This endpoint manages the full lifecycle of an agent interaction, from receiving the initial message through all processing steps until completion. Supports synchronous execution (waits for completion) and asynchronous execution (returns immediately with task ID). The response includes all messages exchanged, tool calls made, and token usage statistics. Ideal for request-response patterns where you need the complete interaction result." parameters: - schema: type: "string" description: "The unique key of identifier of the agent to invoke" required: true description: "The unique key of identifier of the agent to invoke" name: "agent_key" in: "path" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AgentResponseRequest" responses: "200": description: "Agent response successfully created and completed. Returns the full conversation including all messages, tool interactions, model used, and token usage statistics. In background mode, returns immediately with initial task details. In streaming mode, returns Server-Sent Events (SSE) with real-time events." content: application/json: schema: $ref: "#/components/schemas/CreateAgentResponse" text/event-stream: schema: type: object properties: data: $ref: "#/components/schemas/ResponseStreamingEvent" x-speakeasy-sse-sentinel: "[DONE]" security: - ApiKey: [] /v2/agents/{agent_key}/responses/{task_id}: get: tags: - "Agents" deprecated: true x-speakeasy-group: "agents.responses" x-speakeasy-name-override: "get" x-cli-group: "agents" x-cli-name: "getResponse" operationId: "GetAgentResponse" summary: "Get response" description: "Retrieves the current state of an agent response by task ID. Returns the response output, model information, token usage, and execution status. When the agent is still processing, the output array will be empty and status will be `in_progress`. Once completed, the response includes the full output, usage statistics, and finish reason." parameters: - schema: type: "string" description: "The unique key identifier of the agent" required: true description: "The unique key identifier of the agent" name: "agent_key" in: "path" - schema: type: "string" description: "The agent execution task ID returned from create response" required: true description: "The agent execution task ID returned from create response" name: "task_id" in: "path" responses: "200": description: "Response retrieved successfully. Returns the current state of the agent execution including output messages, model used, token usage, and status." content: application/json: schema: $ref: "#/components/schemas/GetAgentResponse" "404": description: "Response not found. The specified task ID does not exist for this agent or workspace." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] /v2/agents/{agent_key}: delete: tags: - "Agents" x-speakeasy-group: "agents" x-speakeasy-name-override: "delete" x-cli-group: "agents" x-cli-name: "delete" x-speakeasy-max-method-params: 1 operationId: "DeleteAgent" summary: "Delete agent" description: "Permanently removes an agent from the workspace. This operation is irreversible and will delete all associated configuration including model assignments, tools, knowledge bases, memory stores, and cached data. Active agent sessions will be terminated, and the agent key will become available for reuse." parameters: - schema: type: "string" description: "The unique key of the agent to delete" required: true description: "The unique key of the agent to delete" name: "agent_key" in: "path" responses: "204": description: "Agent successfully deleted. No content is returned, but the agent has been permanently removed from the workspace." "404": description: "Agent not found. The specified agent key does not exist in the workspace or has already been deleted." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] get: tags: - "Agents" x-speakeasy-group: "agents" x-speakeasy-name-override: "retrieve" x-cli-group: "agents" x-cli-name: "retrieve" x-speakeasy-max-method-params: 1 operationId: "RetrieveAgentRequest" summary: "Retrieve agent" description: "Retrieves detailed information about a specific agent identified by its unique key or identifier. Returns the complete agent manifest including configuration settings, model assignments (primary and fallback), tools, knowledge bases, memory stores, instructions, and execution parameters. Use this endpoint to fetch the current state and configuration of an individual agent." parameters: - schema: type: "string" description: "The unique key of the agent to retrieve" required: true description: "The unique key of the agent to retrieve" name: "agent_key" in: "path" responses: "200": description: "Agent successfully retrieved. Returns the complete agent manifest with all configuration details, including models, tools, knowledge bases, and execution settings." content: application/json: schema: type: "object" properties: _id: type: "string" key: type: "string" pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "Unique identifier for the agent within the workspace" display_name: type: "string" project_id: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" description: "The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." version: type: "string" description: "Current semantic version of the agent manifest." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" memory_stores: type: "array" items: type: "string" default: [] description: "Array of memory store identifiers. Accepts both memory store IDs and keys." team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: "array" items: type: "string" default: [] description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." metrics: type: "object" properties: total_cost: type: "number" minimum: 0 default: 0 default: total_cost: 0 variables: type: "object" additionalProperties: {} description: "Extracted variables from agent instructions" knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" description: "Agent knowledge bases reference" source: type: "string" enum: - "internal" - "external" - "experiment" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" type: type: "string" enum: - "internal" - "a2a" default: "internal" description: "Agent type: internal (Orquesta-managed) or a2a (external A2A-compliant)" role: type: "string" minLength: 1 description: type: "string" system_prompt: type: - "string" - "null" minLength: 1 instructions: type: "string" settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: 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" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" default: [] 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" default: max_execution_time: 600 max_iterations: 100 max_cost: 0 tool_approval_required: "respect_tool" tools: [] model: type: "object" properties: id: type: "string" description: "The database ID of the primary model" integration_id: type: - "string" - "null" description: "Optional integration ID for custom model configurations" parameters: type: - "object" - "null" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors)." fallback_models: type: - "array" - "null" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models (string IDs or config objects) that will be used automatically in order if the primary model fails" required: - "id" required: - "_id" - "key" - "project_id" - "status" - "path" - "role" - "description" - "instructions" - "model" "404": description: "Agent not found. The specified agent key does not exist in the workspace or you do not have permission to access it." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] patch: tags: - "Agents" x-speakeasy-group: "agents" x-speakeasy-name-override: "update" x-cli-group: "agents" x-cli-name: "update" x-speakeasy-max-method-params: 20 operationId: "UpdateAgent" summary: "Update agent" description: "Modifies an existing agent's configuration with partial updates. Supports updating any aspect of the agent including model assignments (primary and fallback), instructions, tools, knowledge bases, memory stores, and execution parameters. Only the fields provided in the request body will be updated; all other fields remain unchanged. Changes take effect immediately for new agent invocations." parameters: - schema: type: "string" description: "The unique key of the agent to update" required: true description: "The unique key of the agent to update" name: "agent_key" in: "path" requestBody: required: true content: application/json: schema: type: "object" properties: key: type: "string" pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" display_name: type: "string" project_id: type: "string" role: type: "string" minLength: 1 description: type: "string" minLength: 1 description: "A brief description of what the agent does" instructions: type: "string" system_prompt: type: - "string" - "null" minLength: 1 description: "A custom system prompt template for the agent. If omitted, the default template is used." model: anyOf: - type: "string" description: "\n\nA model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). The agent can be run with a wide range of models with different capabilities, performance characteristics, and price points. Only models that support tool calling (function_calling) can be used to run agents. See (supported models)[/docs/proxy/supported-models] documentation for the complete list of available models." - type: "object" properties: id: type: "string" description: "A model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). Only models that support tool calling can be used with agents." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Retries are triggered for specific HTTP status codes (e.g., 500, 429, 502, 503, 504). Supports configurable retry count (1-5) and custom status codes." required: - "id" description: "\n\nModel configuration with parameters and retry settings." title: "Model Configuration" description: "Model configuration for agent execution. Can be a simple model ID string or a configuration object with optional behavior parameters and retry settings." fallback_models: type: "array" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models used when the primary model fails. Fallbacks are attempted in order. All models must support tool calling." settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 max_cost: type: "number" minimum: 0 tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: type: "array" items: $ref: "#/components/schemas/AgentToolInputCRUD" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" memory_stores: type: "array" items: type: "string" description: "Array of memory store identifiers. Accepts both memory store IDs and keys." knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" title: "Team of agents" description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: - "array" - "null" items: type: "string" description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." variables: type: "object" additionalProperties: {} description: "Extracted variables from agent instructions" engine: type: "string" enum: - "text" - "jinja" - "mustache" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" description: "Optional semantic version bump to create after a successful publish." versionDescription: type: "string" maxLength: 300 description: "Optional description stored with the created version." responses: "200": description: "Agent configuration successfully updated. Returns the complete updated agent manifest reflecting all changes made." content: application/json: schema: type: "object" properties: _id: type: "string" key: type: "string" pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "Unique identifier for the agent within the workspace" display_name: type: "string" project_id: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" description: "The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." version: type: "string" description: "Current semantic version of the agent manifest." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" memory_stores: type: "array" items: type: "string" default: [] description: "Array of memory store identifiers. Accepts both memory store IDs and keys." team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." skills: type: "array" items: type: "string" default: [] description: "List of skills that the agent can utilize. This field allows you to specify which skills the agent has access to, enabling more complex and dynamic behavior." metrics: type: "object" properties: total_cost: type: "number" minimum: 0 default: 0 default: total_cost: 0 variables: type: "object" additionalProperties: {} description: "Extracted variables from agent instructions" knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" description: "Agent knowledge bases reference" source: type: "string" enum: - "internal" - "external" - "experiment" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" type: type: "string" enum: - "internal" - "a2a" default: "internal" description: "Agent type: internal (Orquesta-managed) or a2a (external A2A-compliant)" role: type: "string" minLength: 1 description: type: "string" system_prompt: type: - "string" - "null" minLength: 1 instructions: type: "string" settings: type: "object" properties: max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "respect_tool" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." tools: 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" key: type: "string" description: "Optional tool key for custom tools" action_type: type: "string" display_name: type: "string" description: type: "string" description: "Optional tool description" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." requires_approval: type: "boolean" default: false tool_id: type: "string" description: "Nested tool ID for MCP tools (identifies specific tool within MCP server)" conditions: type: "array" items: type: "object" properties: condition: type: "string" description: "The argument of the tool call to evaluate" operator: type: "string" description: "The operator to use" value: type: "string" description: "The value to compare against" required: - "condition" - "operator" - "value" default: [] timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "id" - "action_type" default: [] 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" default: max_execution_time: 600 max_iterations: 100 max_cost: 0 tool_approval_required: "respect_tool" tools: [] model: type: "object" properties: id: type: "string" description: "The database ID of the primary model" integration_id: type: - "string" - "null" description: "Optional integration ID for custom model configurations" parameters: type: - "object" - "null" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors)." fallback_models: type: - "array" - "null" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models (string IDs or config objects) that will be used automatically in order if the primary model fails" required: - "id" required: - "_id" - "key" - "project_id" - "status" - "path" - "role" - "description" - "instructions" - "model" "404": description: "Agent not found. The specified agent key does not exist in the workspace or you do not have permission to modify it." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/agents/{key}/task: post: tags: - "Agents" x-cli-group: "agents" x-cli-name: "invoke" deprecated: true x-speakeasy-group: "agents" x-speakeasy-name-override: "invoke" x-speakeasy-max-method-params: 11 operationId: "InvokeAgent" summary: "Execute an agent task" description: "Invokes an agent to perform a task with the provided input message. The agent will process the request using its configured model and tools, maintaining context through memory stores if configured. Supports automatic model fallback on primary model failure, tool execution, knowledge base retrieval, and continuation of previous conversations. Returns a task response that can be used to track execution status and retrieve results." parameters: - schema: type: "string" description: "The key or ID of the agent to invoke" required: true description: "The key or ID of the agent to invoke" name: "key" in: "path" requestBody: content: application/json: schema: type: "object" properties: task_id: type: "string" description: "Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue." message: type: "object" properties: messageId: type: "string" description: "Optional A2A message ID in ULID format" role: anyOf: - type: "string" enum: - "user" title: "User message" description: "Message from the end user" - type: "string" enum: - "tool" title: "Tool message" description: "Message containing tool execution results" description: "Message role (user or tool for continuing executions)" parts: type: "array" items: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "Text content part. Use this to send text messages to the agent." - allOf: - $ref: "#/components/schemas/FilePart" - description: "File attachment part. Use this to send files (images, documents, etc.) to the agent for processing." - allOf: - $ref: "#/components/schemas/ToolResultPart" - description: "Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request." - allOf: - $ref: "#/components/schemas/ErrorPart" - description: "Error content part. Generated by the system when an error occurs during agent execution." discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" file: "#/components/schemas/FilePart" tool_result: "#/components/schemas/ToolResultPart" error: "#/components/schemas/ErrorPart" title: "Public Message Part" description: "Message part that can be provided by users. Use \"text\" for regular messages, \"file\" for attachments, or \"tool_result\" when responding to tool call requests." description: "A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts." required: - "role" - "parts" title: "A2A Message" description: "The A2A message to send to the agent (user input or tool results)" variables: type: "object" additionalProperties: {} description: "Optional variables for template replacement in system prompt, instructions, and messages" identity: 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." contact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" memory: type: "object" properties: entity_id: type: "string" description: "An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions." required: - "entity_id" description: "Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions." metadata: type: "object" additionalProperties: {} description: "Optional metadata for the agent invocation as key-value pairs that will be included in traces" engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "Override template engine for this invocation. If not provided, uses the agent default." configuration: type: "object" properties: blocking: type: "boolean" default: false description: "Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status." description: "Configuration options for the agent invocation" required: - "message" title: "A2A Invoke Request" description: "Request body for invoking an existing agent (stream-task endpoint). Used to start a new task or continue an existing conversation." responses: "200": description: "Agent task successfully initiated. Returns the task details including task ID, execution status, and initial response. Use the task ID to track execution progress and retrieve full results." content: application/json: schema: type: "object" properties: id: type: "string" description: "The unique ID of the created agent execution task" contextId: type: "string" description: "The correlation ID for this execution (used for tracking)" kind: type: "string" enum: - "task" description: "A2A entity type identifier" status: type: "object" properties: state: type: "string" enum: - "submitted" - "working" - "input-required" - "auth-required" - "completed" - "failed" - "canceled" - "rejected" title: "Task State" description: "Current state of the agent task execution. Values: submitted (queued), working (executing), input-required (awaiting user input), completed (finished successfully), failed (error occurred). Note: auth-required, canceled, and rejected statuses are defined for A2A protocol compatibility but are not currently supported in task execution." timestamp: type: "string" description: "ISO 8601 timestamp of when the status was updated" message: type: "object" properties: kind: type: "string" enum: - "message" messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" title: "Extended Message Role" description: "Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts)." parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" required: - "kind" - "messageId" - "role" - "parts" title: "Task Status Message" description: "Optional A2A message providing additional context about the current status" required: - "state" title: "Task Status" description: "Current task status information" messages: type: "array" description: "Array of messages in the task conversation. Only present when blocking mode is enabled." items: $ref: "#/components/schemas/ExtendedMessage" metadata: type: "object" additionalProperties: {} description: "Task metadata containing workspace_id and trace_id for feedback and tracking" required: - "id" - "contextId" - "kind" - "status" title: "A2A Task Response" description: "Response format following the Agent-to-Agent (A2A) protocol. Returned when starting or continuing an agent task execution." security: - ApiKey: [] /v2/agents/run: post: tags: - "Agents" x-cli-group: "agents" x-cli-name: "run" deprecated: true x-speakeasy-group: "agents" x-speakeasy-name-override: "run" x-speakeasy-max-method-params: 21 operationId: "RunAgent" summary: "Run an agent with configuration" description: "Executes an agent using inline configuration or references an existing agent. Supports dynamic agent creation where the system automatically manages agent versioning - reusing existing agents with matching configurations or creating new versions when configurations differ. Ideal for programmatic agent execution with flexible configuration management. The agent processes messages in A2A format with support for memory context, tool execution, and automatic model fallback on failure." requestBody: required: true content: application/json: schema: type: "object" properties: key: type: "string" minLength: 1 pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "A unique identifier for the agent. This key must be unique within the same workspace and cannot be reused. When executing the agent, this key determines if the agent already exists. If the agent version differs, a new version is created at the end of the execution, except for the task. All agent parameters are evaluated to decide if a new version is needed." task_id: type: "string" description: "Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue." model: anyOf: - type: "string" description: "\n\nA model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). The agent can be run with a wide range of models with different capabilities, performance characteristics, and price points. Only models that support tool calling (function_calling) can be used to run agents. See (supported models)[/docs/proxy/supported-models] documentation for the complete list of available models." - type: "object" properties: id: type: "string" description: "A model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). Only models that support tool calling can be used with agents." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Retries are triggered for specific HTTP status codes (e.g., 500, 429, 502, 503, 504). Supports configurable retry count (1-5) and custom status codes." required: - "id" description: "\n\nModel configuration with parameters and retry settings." title: "Model Configuration" description: "Model configuration for this execution. Can override the agent manifest defaults if the agent already exists." fallback_models: type: "array" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models used when the primary model fails. Fallbacks are attempted in order. All models must support tool calling." role: type: "string" minLength: 1 description: "Specifies the agent's function and area of expertise." instructions: type: "string" minLength: 1 description: "Provides context and purpose for the agent. Combined with the system prompt template to generate the agent's instructions." message: type: "object" properties: messageId: type: "string" description: "Optional A2A message ID in ULID format" role: anyOf: - type: "string" enum: - "user" title: "User message" description: "Message from the end user" - type: "string" enum: - "tool" title: "Tool message" description: "Message containing tool execution results" description: "Message role (user or tool for continuing executions)" parts: type: "array" items: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "Text content part. Use this to send text messages to the agent." - allOf: - $ref: "#/components/schemas/FilePart" - description: "File attachment part. Use this to send files (images, documents, etc.) to the agent for processing." - allOf: - $ref: "#/components/schemas/ToolResultPart" - description: "Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request." - allOf: - $ref: "#/components/schemas/ErrorPart" - description: "Error content part. Generated by the system when an error occurs during agent execution." discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" file: "#/components/schemas/FilePart" tool_result: "#/components/schemas/ToolResultPart" error: "#/components/schemas/ErrorPart" title: "Public Message Part" description: "Message part that can be provided by users. Use \"text\" for regular messages, \"file\" for attachments, or \"tool_result\" when responding to tool call requests." description: "A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts." required: - "role" - "parts" title: "A2A Message" description: "The A2A format message containing the task for the agent to perform." variables: type: "object" additionalProperties: {} description: "Optional variables for template replacement in system prompt, instructions, and messages" identity: 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." contact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" memory: type: "object" properties: entity_id: type: "string" description: "An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions." required: - "entity_id" description: "Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" description: type: "string" minLength: 1 description: "A brief summary of the agent's purpose." system_prompt: type: - "string" - "null" minLength: 1 description: "A custom system prompt template for the agent. If omitted, the default template is used." memory_stores: type: "array" items: type: "string" default: [] title: "Memory stores" description: "Array of memory store identifiers that are accessible to the agent. Accepts both memory store IDs and keys." knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" default: [] description: "Knowledge base configurations for the agent to access" team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." settings: type: "object" properties: tools: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "google_search" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Google search tool" description: "Performs Google searches to retrieve web content" - type: "object" properties: type: type: "string" enum: - "web_scraper" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Web scraper tool" description: "Scrapes and extracts content from web pages" - type: "object" properties: type: type: "string" enum: - "call_sub_agent" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Call sub agent tool" description: "Delegates tasks to specialized sub-agents" - type: "object" properties: type: type: "string" enum: - "retrieve_agents" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve agents tool" description: "Retrieves available agents in the system" - type: "object" properties: type: type: "string" enum: - "query_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query memory store tool" description: "Queries agent memory stores for context" - type: "object" properties: type: type: "string" enum: - "write_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Write memory store tool" description: "Writes information to agent memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_memory_stores" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve memory stores tool" description: "Lists available memory stores" - type: "object" properties: type: type: "string" enum: - "delete_memory_document" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Delete memory document tool" description: "Deletes documents from memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_knowledge_bases" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve knowledge bases tool" description: "Lists available knowledge bases" - type: "object" properties: type: type: "string" enum: - "query_knowledge_base" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query knowledge base tool" description: "Queries knowledge bases for information" - type: "object" properties: type: type: "string" enum: - "current_date" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Current date tool" description: "Returns the current date and time" - type: "object" properties: type: type: "string" enum: - "advisor" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Advisor tool" description: "Consult a secondary model for advice on the current task" - type: "object" properties: type: type: "string" enum: - "sidekick" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Sidekick tool" description: "Delegate a subtask to a secondary model for execution" - type: "object" properties: type: type: "string" enum: - "code_interpreter" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Code interpreter tool" description: "Executes model-written Python code. Uses provider-native code execution when the model supports it, otherwise a secure orq-managed sandbox." - type: "object" properties: type: type: "string" enum: - "http" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" requires_approval: type: "boolean" default: false timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "type" - "key" - "description" - "http" title: "HTTP Tool (Run)" description: "HTTP tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "code" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" requires_approval: type: "boolean" default: false timeout: type: "number" minimum: 1 maximum: 120 description: "Tool execution timeout in seconds for this agent (max: 2 minutes, the code sandbox cap). Overrides the timeout configured on the tool definition." required: - "type" - "key" - "description" - "code_tool" title: "Code Tool (Run)" description: "Code execution tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "function" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" requires_approval: type: "boolean" default: false required: - "type" - "key" - "function" title: "Function Tool (Run)" description: "Function tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "json_schema" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" requires_approval: type: "boolean" default: false required: - "type" - "key" - "description" - "json_schema" title: "JSON Schema Tool (Run)" description: "JSON Schema tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "mcp" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6FCYQSQFE5RM7ECKXMC" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" requires_approval: type: "boolean" default: false required: - "type" - "key" - "description" - "mcp" title: "MCP Tool (Run)" description: "MCP tool with inline definition for on-the-fly creation in run endpoint" description: "Tool configuration for agent run operations. Built-in tools only require a type and requires_approval, while custom tools (HTTP, Code, Function, JSON Schema, MCP) support full inline definitions for on-the-fly creation." title: "Agent Tool Input (Run)" default: [] description: "Tools available to the agent" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "none" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" metadata: type: "object" additionalProperties: {} description: "Optional metadata for the agent run as key-value pairs that will be included in traces" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" description: "Template engine for variable interpolation. Text uses {{variable}} syntax, Jinja supports loops/conditionals/filters, Mustache uses {{#section}} syntax." required: - "key" - "model" - "role" - "instructions" - "message" - "path" - "settings" responses: "200": description: "Agent execution initiated successfully. Returns task details including the task ID, execution status, and agent response. The task ID can be used to track execution progress and retrieve results." content: application/json: schema: type: "object" properties: id: type: "string" description: "The unique ID of the created agent execution task" contextId: type: "string" description: "The correlation ID for this execution (used for tracking)" kind: type: "string" enum: - "task" description: "A2A entity type identifier" status: type: "object" properties: state: type: "string" enum: - "submitted" - "working" - "input-required" - "auth-required" - "completed" - "failed" - "canceled" - "rejected" title: "Task State" description: "Current state of the agent task execution. Values: submitted (queued), working (executing), input-required (awaiting user input), completed (finished successfully), failed (error occurred). Note: auth-required, canceled, and rejected statuses are defined for A2A protocol compatibility but are not currently supported in task execution." timestamp: type: "string" description: "ISO 8601 timestamp of when the status was updated" message: type: "object" properties: kind: type: "string" enum: - "message" messageId: type: "string" role: type: "string" enum: - "user" - "agent" - "tool" - "system" title: "Extended Message Role" description: "Role of the message sender in the A2A protocol. Values: user (end user), agent (AI agent), tool (tool execution result), system (system instructions/prompts)." parts: type: "array" items: oneOf: - $ref: "#/components/schemas/TextPart" - $ref: "#/components/schemas/ErrorPart" - $ref: "#/components/schemas/DataPart" - $ref: "#/components/schemas/FilePart" - $ref: "#/components/schemas/ToolCallPart" - $ref: "#/components/schemas/ToolResultPart" discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" error: "#/components/schemas/ErrorPart" data: "#/components/schemas/DataPart" file: "#/components/schemas/FilePart" tool_call: "#/components/schemas/ToolCallPart" tool_result: "#/components/schemas/ToolResultPart" required: - "kind" - "messageId" - "role" - "parts" title: "Task Status Message" description: "Optional A2A message providing additional context about the current status" required: - "state" title: "Task Status" description: "Current task status information" messages: type: "array" description: "Array of messages in the task conversation. Only present when blocking mode is enabled." items: $ref: "#/components/schemas/ExtendedMessage" metadata: type: "object" additionalProperties: {} description: "Task metadata containing workspace_id and trace_id for feedback and tracking" required: - "id" - "contextId" - "kind" - "status" title: "A2A Task Response" description: "Response format following the Agent-to-Agent (A2A) protocol. Returned when starting or continuing an agent task execution." security: - ApiKey: [] /v2/agents/stream-run: post: tags: - "Agents" x-cli-group: "agents" x-cli-name: "streamRun" deprecated: true x-speakeasy-group: "agents" x-speakeasy-name-override: "streamRun" x-speakeasy-max-method-params: 22 operationId: "StreamRunAgent" summary: "Run agent with streaming response" description: "Dynamically configures and executes an agent while streaming the interaction in real-time via Server-Sent Events (SSE). Intelligently manages agent versioning by reusing existing agents with matching configurations or creating new versions when configurations differ. Combines the flexibility of inline configuration with real-time streaming, making it ideal for dynamic agent interactions with live feedback. The stream provides continuous updates including message chunks, tool executions, and status changes until completion or timeout." requestBody: required: true content: application/json: schema: type: "object" properties: key: type: "string" minLength: 1 pattern: "^[A-Za-z][A-Za-z0-9]*([._-][A-Za-z0-9]+)*$" description: "A unique identifier for the agent. This key must be unique within the same workspace and cannot be reused. When executing the agent, this key determines if the agent already exists. If the agent version differs, a new version is created at the end of the execution, except for the task. All agent parameters are evaluated to decide if a new version is needed." task_id: type: "string" description: "Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue." model: anyOf: - type: "string" description: "\n\nA model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). The agent can be run with a wide range of models with different capabilities, performance characteristics, and price points. Only models that support tool calling (function_calling) can be used to run agents. See (supported models)[/docs/proxy/supported-models] documentation for the complete list of available models." - type: "object" properties: id: type: "string" description: "A model ID string (e.g., `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`). Only models that support tool calling can be used with agents." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Model behavior parameters that control how the model generates responses. Common parameters: `temperature` (0-1, randomness), `max_completion_tokens` (max output length), `top_p` (sampling diversity). Advanced: `frequency_penalty`, `presence_penalty`, `response_format` (JSON/structured), `reasoning_effort`, `seed` (reproducibility). Support varies by model - consult AI Gateway documentation." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for model requests. Retries are triggered for specific HTTP status codes (e.g., 500, 429, 502, 503, 504). Supports configurable retry count (1-5) and custom status codes." required: - "id" description: "\n\nModel configuration with parameters and retry settings." title: "Model Configuration" description: "Model configuration for this execution. Can override the agent manifest defaults if the agent already exists." fallback_models: type: "array" items: anyOf: - type: "string" description: "A fallback model ID string (e.g., `openai/gpt-4o-mini`). Will be used if the primary model request fails. Must support tool calling." - type: "object" properties: id: type: "string" description: "A fallback model ID string. Must support tool calling." parameters: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." description: "Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for this fallback model. Allows customizing retry count (1-5) and HTTP status codes that trigger retries." required: - "id" description: "Fallback model configuration with optional parameters and retry settings." title: "Fallback Model Configuration" description: "Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order." description: "Optional array of fallback models used when the primary model fails. Fallbacks are attempted in order. All models must support tool calling." role: type: "string" minLength: 1 description: "Specifies the agent's function and area of expertise." instructions: type: "string" minLength: 1 description: "Provides context and purpose for the agent. Combined with the system prompt template to generate the agent's instructions." message: type: "object" properties: messageId: type: "string" description: "Optional A2A message ID in ULID format" role: anyOf: - type: "string" enum: - "user" title: "User message" description: "Message from the end user" - type: "string" enum: - "tool" title: "Tool message" description: "Message containing tool execution results" description: "Message role (user or tool for continuing executions)" parts: type: "array" items: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "Text content part. Use this to send text messages to the agent." - allOf: - $ref: "#/components/schemas/FilePart" - description: "File attachment part. Use this to send files (images, documents, etc.) to the agent for processing." - allOf: - $ref: "#/components/schemas/ToolResultPart" - description: "Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request." - allOf: - $ref: "#/components/schemas/ErrorPart" - description: "Error content part. Generated by the system when an error occurs during agent execution." discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" file: "#/components/schemas/FilePart" tool_result: "#/components/schemas/ToolResultPart" error: "#/components/schemas/ErrorPart" title: "Public Message Part" description: "Message part that can be provided by users. Use \"text\" for regular messages, \"file\" for attachments, or \"tool_result\" when responding to tool call requests." description: "A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts." required: - "role" - "parts" title: "A2A Message" description: "The A2A format message containing the task for the agent to perform." variables: type: "object" additionalProperties: {} description: "Optional variables for template replacement in system prompt, instructions, and messages" identity: 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." contact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" memory: type: "object" properties: entity_id: type: "string" description: "An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions." required: - "entity_id" description: "Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" description: type: "string" minLength: 1 description: "A brief summary of the agent's purpose." system_prompt: type: - "string" - "null" minLength: 1 description: "A custom system prompt template for the agent. If omitted, the default template is used." memory_stores: type: "array" items: type: "string" default: [] title: "Memory stores" description: "Array of memory store identifiers that are accessible to the agent. Accepts both memory store IDs and keys." knowledge_bases: type: "array" items: type: "object" properties: knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" required: - "knowledge_id" default: [] description: "Knowledge base configurations for the agent to access" team_of_agents: type: "array" items: type: "object" properties: key: type: "string" description: "The unique key of the agent within the workspace" role: type: "string" description: "The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to." required: - "key" default: [] description: "The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks." settings: type: "object" properties: tools: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "google_search" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Google search tool" description: "Performs Google searches to retrieve web content" - type: "object" properties: type: type: "string" enum: - "web_scraper" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Web scraper tool" description: "Scrapes and extracts content from web pages" - type: "object" properties: type: type: "string" enum: - "call_sub_agent" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Call sub agent tool" description: "Delegates tasks to specialized sub-agents" - type: "object" properties: type: type: "string" enum: - "retrieve_agents" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve agents tool" description: "Retrieves available agents in the system" - type: "object" properties: type: type: "string" enum: - "query_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query memory store tool" description: "Queries agent memory stores for context" - type: "object" properties: type: type: "string" enum: - "write_memory_store" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Write memory store tool" description: "Writes information to agent memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_memory_stores" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve memory stores tool" description: "Lists available memory stores" - type: "object" properties: type: type: "string" enum: - "delete_memory_document" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Delete memory document tool" description: "Deletes documents from memory stores" - type: "object" properties: type: type: "string" enum: - "retrieve_knowledge_bases" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Retrieve knowledge bases tool" description: "Lists available knowledge bases" - type: "object" properties: type: type: "string" enum: - "query_knowledge_base" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Query knowledge base tool" description: "Queries knowledge bases for information" - type: "object" properties: type: type: "string" enum: - "current_date" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Current date tool" description: "Returns the current date and time" - type: "object" properties: type: type: "string" enum: - "advisor" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Advisor tool" description: "Consult a secondary model for advice on the current task" - type: "object" properties: type: type: "string" enum: - "sidekick" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Sidekick tool" description: "Delegate a subtask to a secondary model for execution" - type: "object" properties: type: type: "string" enum: - "code_interpreter" requires_approval: type: "boolean" description: "Whether this tool requires approval before execution" configuration: type: "object" additionalProperties: {} description: "Static tool configuration set at design time. Merged over LLM-provided arguments at execution time." required: - "type" title: "Code interpreter tool" description: "Executes model-written Python code. Uses provider-native code execution when the model supports it, otherwise a secure orq-managed sandbox." - type: "object" properties: type: type: "string" enum: - "http" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" requires_approval: type: "boolean" default: false timeout: type: "number" minimum: 1 maximum: 600 description: "Tool execution timeout in seconds for this agent (max: 10 minutes). Overrides the timeout configured on the tool definition." required: - "type" - "key" - "description" - "http" title: "HTTP Tool (Run)" description: "HTTP tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "code" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" requires_approval: type: "boolean" default: false timeout: type: "number" minimum: 1 maximum: 120 description: "Tool execution timeout in seconds for this agent (max: 2 minutes, the code sandbox cap). Overrides the timeout configured on the tool definition." required: - "type" - "key" - "description" - "code_tool" title: "Code Tool (Run)" description: "Code execution tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "function" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" requires_approval: type: "boolean" default: false required: - "type" - "key" - "function" title: "Function Tool (Run)" description: "Function tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "json_schema" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" requires_approval: type: "boolean" default: false required: - "type" - "key" - "description" - "json_schema" title: "JSON Schema Tool (Run)" description: "JSON Schema tool with inline definition for on-the-fly creation in run endpoint" - type: "object" properties: type: type: "string" enum: - "mcp" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" _id: type: "string" display_name: type: "string" description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6H4F2HM7Y558GGAXYV3" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" requires_approval: type: "boolean" default: false required: - "type" - "key" - "description" - "mcp" title: "MCP Tool (Run)" description: "MCP tool with inline definition for on-the-fly creation in run endpoint" description: "Tool configuration for agent run operations. Built-in tools only require a type and requires_approval, while custom tools (HTTP, Code, Function, JSON Schema, MCP) support full inline definitions for on-the-fly creation." title: "Agent Tool Input (Run)" default: [] description: "Tools available to the agent" tool_approval_required: type: "string" enum: - "all" - "respect_tool" - "none" default: "none" description: "If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools." max_iterations: type: "integer" exclusiveMinimum: 0 maximum: 100 minimum: 1 default: 100 description: "Maximum iterations(llm calls) before the agent will stop executing." max_execution_time: type: "integer" minimum: 2 exclusiveMinimum: 0 maximum: 600 default: 600 description: "Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned." max_cost: type: "number" minimum: 0 default: 0 description: "Maximum cost in USD for the agent execution. When the accumulated cost exceeds this limit, the agent will stop executing. Set to 0 for unlimited. Only supported in v3 responses" chat_exposed: type: "boolean" description: "When enabled, this agent is exposed as a selectable target in AI Chat for users to consume." 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent evaluator configuration" description: "Configuration for an evaluator applied to the agent" 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" description: "Determines whether the evaluator runs on the agent input (user message) or output (agent response)." required: - "id" - "execute_on" title: "Agent guardrail configuration" description: "Configuration for a guardrail applied to the agent" metadata: type: "object" additionalProperties: {} description: "Optional metadata for the agent run as key-value pairs that will be included in traces" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" description: "Template engine for variable interpolation. Text uses {{variable}} syntax, Jinja supports loops/conditionals/filters, Mustache uses {{#section}} syntax." stream_timeout_seconds: type: "number" minimum: 1 maximum: 3600 description: "Stream timeout in seconds (1-3600). Default: 1800 (30 minutes)" required: - "key" - "model" - "role" - "instructions" - "message" - "path" - "settings" responses: "200": description: "Server-Sent Event stream successfully established. Delivers real-time agent execution events including message fragments, tool invocations, intermediate results, and completion status. Stream terminates with [DONE] sentinel upon completion." content: text/event-stream: schema: type: "object" properties: data: oneOf: - $ref: "#/components/schemas/AgentExecutionStartedStreamingEvent" - $ref: "#/components/schemas/AgentStartedStreamingEvent" - $ref: "#/components/schemas/AgentThoughtStreamingEvent" - $ref: "#/components/schemas/AgentInactiveStreamingEvent" - $ref: "#/components/schemas/AgentErroredStreamingEvent" - $ref: "#/components/schemas/ActionReviewRequestedStreamingEvent" - $ref: "#/components/schemas/ActionReviewedStreamingEvent" - $ref: "#/components/schemas/ExecutionReviewRequiredStreamingEvent" - $ref: "#/components/schemas/ExecutionReviewedStreamingEvent" - $ref: "#/components/schemas/ExecutionNamedStreamingEvent" - $ref: "#/components/schemas/AgentHandedOffStreamingEvent" - $ref: "#/components/schemas/AgentMessageCreatedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionStartedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionFinishedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionFailedStreamingEvent" - $ref: "#/components/schemas/TimeoutStreamingEvent" - $ref: "#/components/schemas/ErrorStreamingEvent" discriminator: propertyName: "type" mapping: agents.execution_started: "#/components/schemas/AgentExecutionStartedStreamingEvent" event.agents.started: "#/components/schemas/AgentStartedStreamingEvent" event.agents.thought: "#/components/schemas/AgentThoughtStreamingEvent" event.agents.inactive: "#/components/schemas/AgentInactiveStreamingEvent" event.agents.errored: "#/components/schemas/AgentErroredStreamingEvent" event.agents.action_review_requested: "#/components/schemas/ActionReviewRequestedStreamingEvent" event.agents.action_reviewed: "#/components/schemas/ActionReviewedStreamingEvent" event.agents.execution_review_required: "#/components/schemas/ExecutionReviewRequiredStreamingEvent" event.agents.execution_reviewed: "#/components/schemas/ExecutionReviewedStreamingEvent" event.agents.execution_named: "#/components/schemas/ExecutionNamedStreamingEvent" event.agents.handed_off: "#/components/schemas/AgentHandedOffStreamingEvent" event.agents.message-created: "#/components/schemas/AgentMessageCreatedStreamingEvent" event.workflow_events.tool_execution_started: "#/components/schemas/ToolExecutionStartedStreamingEvent" event.workflow_events.tool_execution_finished: "#/components/schemas/ToolExecutionFinishedStreamingEvent" event.workflow_events.tool_execution_failed: "#/components/schemas/ToolExecutionFailedStreamingEvent" agents.timeout: "#/components/schemas/TimeoutStreamingEvent" agents.error: "#/components/schemas/ErrorStreamingEvent" required: - "data" x-speakeasy-sse-sentinel: "[DONE]" "404": description: "Model not found" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/agents/{key}/stream-task: post: tags: - "Agents" x-cli-group: "agents" x-cli-name: "stream" deprecated: true x-speakeasy-group: "agents" x-speakeasy-name-override: "stream" x-speakeasy-max-method-params: 12 operationId: "StreamAgent" summary: "Stream agent execution in real-time" description: "Executes an agent and streams the interaction in real-time using Server-Sent Events (SSE). Provides live updates as the agent processes the request, including message chunks, tool calls, and execution status. Perfect for building responsive chat interfaces and monitoring agent progress. The stream continues until the agent completes its task, encounters an error, or reaches the configured timeout (default 30 minutes, configurable 1-3600 seconds)." parameters: - schema: type: "string" description: "The key or ID of the agent to invoke" required: true description: "The key or ID of the agent to invoke" name: "key" in: "path" requestBody: required: true content: application/json: schema: type: "object" properties: task_id: type: "string" description: "Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue." message: type: "object" properties: messageId: type: "string" description: "Optional A2A message ID in ULID format" role: anyOf: - type: "string" enum: - "user" title: "User message" description: "Message from the end user" - type: "string" enum: - "tool" title: "Tool message" description: "Message containing tool execution results" description: "Message role (user or tool for continuing executions)" parts: type: "array" items: oneOf: - allOf: - $ref: "#/components/schemas/TextPart" - description: "Text content part. Use this to send text messages to the agent." - allOf: - $ref: "#/components/schemas/FilePart" - description: "File attachment part. Use this to send files (images, documents, etc.) to the agent for processing." - allOf: - $ref: "#/components/schemas/ToolResultPart" - description: "Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request." - allOf: - $ref: "#/components/schemas/ErrorPart" - description: "Error content part. Generated by the system when an error occurs during agent execution." discriminator: propertyName: "kind" mapping: text: "#/components/schemas/TextPart" file: "#/components/schemas/FilePart" tool_result: "#/components/schemas/ToolResultPart" error: "#/components/schemas/ErrorPart" title: "Public Message Part" description: "Message part that can be provided by users. Use \"text\" for regular messages, \"file\" for attachments, or \"tool_result\" when responding to tool call requests." description: "A2A message parts (text, file, or tool_result only). Note: Tool role messages must only contain tool_result parts." required: - "role" - "parts" title: "A2A Message" description: "The A2A message to send to the agent (user input or tool results)" variables: type: "object" additionalProperties: {} description: "Optional variables for template replacement in system prompt, instructions, and messages" identity: 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." contact: 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: "@deprecated Use identity instead. Information about the contact making the request." deprecated: true thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" memory: type: "object" properties: entity_id: type: "string" description: "An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions." required: - "entity_id" description: "Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions." metadata: type: "object" additionalProperties: {} description: "Optional metadata for the agent invocation as key-value pairs that will be included in traces" engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "Override template engine for this invocation. If not provided, uses the agent default." configuration: type: "object" properties: blocking: type: "boolean" default: false description: "Whether to block until the agent task completes. When true, the response will include the full task with messages. When false (default), returns immediately with task ID and status." description: "Configuration options for the agent invocation" stream_timeout_seconds: type: "number" minimum: 1 maximum: 3600 description: "Stream timeout in seconds (1-3600). Default: 1800 (30 minutes)" required: - "message" title: "A2A Invoke Request" description: "Request body for invoking an existing agent (stream-task endpoint). Used to start a new task or continue an existing conversation." responses: "200": description: "Server-Sent Event stream successfully established. Returns real-time events including agent messages, tool calls, status updates, and completion signals. The stream ends with a [DONE] sentinel value." content: text/event-stream: schema: type: "object" properties: data: oneOf: - $ref: "#/components/schemas/AgentExecutionStartedStreamingEvent" - $ref: "#/components/schemas/AgentStartedStreamingEvent" - $ref: "#/components/schemas/AgentThoughtStreamingEvent" - $ref: "#/components/schemas/AgentInactiveStreamingEvent" - $ref: "#/components/schemas/AgentErroredStreamingEvent" - $ref: "#/components/schemas/ActionReviewRequestedStreamingEvent" - $ref: "#/components/schemas/ActionReviewedStreamingEvent" - $ref: "#/components/schemas/ExecutionReviewRequiredStreamingEvent" - $ref: "#/components/schemas/ExecutionReviewedStreamingEvent" - $ref: "#/components/schemas/ExecutionNamedStreamingEvent" - $ref: "#/components/schemas/AgentHandedOffStreamingEvent" - $ref: "#/components/schemas/AgentMessageCreatedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionStartedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionFinishedStreamingEvent" - $ref: "#/components/schemas/ToolExecutionFailedStreamingEvent" - $ref: "#/components/schemas/TimeoutStreamingEvent" - $ref: "#/components/schemas/ErrorStreamingEvent" discriminator: propertyName: "type" mapping: agents.execution_started: "#/components/schemas/AgentExecutionStartedStreamingEvent" event.agents.started: "#/components/schemas/AgentStartedStreamingEvent" event.agents.thought: "#/components/schemas/AgentThoughtStreamingEvent" event.agents.inactive: "#/components/schemas/AgentInactiveStreamingEvent" event.agents.errored: "#/components/schemas/AgentErroredStreamingEvent" event.agents.action_review_requested: "#/components/schemas/ActionReviewRequestedStreamingEvent" event.agents.action_reviewed: "#/components/schemas/ActionReviewedStreamingEvent" event.agents.execution_review_required: "#/components/schemas/ExecutionReviewRequiredStreamingEvent" event.agents.execution_reviewed: "#/components/schemas/ExecutionReviewedStreamingEvent" event.agents.execution_named: "#/components/schemas/ExecutionNamedStreamingEvent" event.agents.handed_off: "#/components/schemas/AgentHandedOffStreamingEvent" event.agents.message-created: "#/components/schemas/AgentMessageCreatedStreamingEvent" event.workflow_events.tool_execution_started: "#/components/schemas/ToolExecutionStartedStreamingEvent" event.workflow_events.tool_execution_finished: "#/components/schemas/ToolExecutionFinishedStreamingEvent" event.workflow_events.tool_execution_failed: "#/components/schemas/ToolExecutionFailedStreamingEvent" agents.timeout: "#/components/schemas/TimeoutStreamingEvent" agents.error: "#/components/schemas/ErrorStreamingEvent" required: - "data" x-speakeasy-sse-sentinel: "[DONE]" "404": description: "Agent not found" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/prompts: get: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "list" x-cli-group: "prompts" x-cli-name: "list" operationId: "GetAllPrompts" summary: "List all prompts" description: "Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first" parameters: - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Prompts retrieved." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" type: type: "string" enum: - "prompt" owner: type: "string" domain_id: type: "string" format: "uuid" created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "type" - "owner" - "domain_id" - "created" - "updated" - "display_name" - "prompt" title: "Prompt" description: "A prompt entity with configuration, metadata, and versioning." has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] post: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "create" x-cli-group: "prompts" x-cli-name: "create" operationId: "CreatePrompt" summary: "Create a prompt" requestBody: content: application/json: schema: type: "object" properties: display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" prompt: type: "object" properties: 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." example: - role: "system" content: "You are a helpful assistant" - role: "user" content: "What is the weather today?" model: type: "string" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway-supported-models. Only chat models are supported." example: "openai/gpt-4o" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." required: - "messages" title: "PromptInput" description: "Prompt configuration with model and messages." example: model: "openai/gpt-4o" messages: - role: "system" content: "You are a helpful assistant" - role: "user" content: "What is the weather today?" temperature: 0.7 max_tokens: 1000 path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" required: - "display_name" - "prompt" - "path" title: "CreatePromptRequest" description: "Request body for creating a new prompt." responses: "200": description: "Prompt created." content: application/json: schema: type: "object" properties: _id: type: "string" type: type: "string" enum: - "prompt" owner: type: "string" domain_id: type: "string" format: "uuid" created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "type" - "owner" - "domain_id" - "created" - "updated" - "display_name" - "prompt" title: "Prompt" description: "A prompt entity with configuration, metadata, and versioning." security: - ApiKey: [] /v2/prompts/{id}: get: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "retrieve" x-cli-group: "prompts" x-cli-name: "retrieve" operationId: "GetOnePrompt" summary: "Retrieve a prompt" description: "Retrieves a prompt object" parameters: - schema: type: "string" description: "Unique identifier of the prompt" required: true description: "Unique identifier of the prompt" name: "id" in: "path" responses: "200": description: "Prompt retrieved." content: application/json: schema: type: "object" properties: _id: type: "string" type: type: "string" enum: - "prompt" owner: type: "string" domain_id: type: "string" format: "uuid" created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "type" - "owner" - "domain_id" - "created" - "updated" - "display_name" - "prompt" title: "Prompt" description: "A prompt entity with configuration, metadata, and versioning." security: - ApiKey: [] patch: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "update" x-cli-group: "prompts" x-cli-name: "update" operationId: "UpdatePrompt" summary: "Update a prompt" parameters: - schema: type: "string" description: "Unique identifier of the prompt" required: true description: "Unique identifier of the prompt" name: "id" in: "path" requestBody: content: application/json: schema: type: "object" properties: owner: type: "string" domain_id: type: "string" format: "uuid" created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt: type: "object" properties: 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." example: - role: "system" content: "You are a helpful assistant" - role: "user" content: "What is the weather today?" model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway-supported-models. Only chat models are supported." example: "openai/gpt-4o" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." title: "PromptInput" description: "Prompt configuration with model and messages. Use this to update the prompt." example: model: "anthropic/claude-3-5-sonnet-20241022" messages: - role: "system" content: "You are a helpful assistant" - role: "user" content: "Hello!" temperature: 0.5 metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" title: "UpdatePromptRequest" description: "Request body for updating an existing prompt. All fields are optional." responses: "200": description: "Prompt updated." content: application/json: schema: type: "object" properties: _id: type: "string" type: type: "string" enum: - "prompt" owner: type: "string" domain_id: type: "string" format: "uuid" created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" display_name: type: "string" maxLength: 128 description: "The prompt’s name, meant to be displayable in the UI." description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "type" - "owner" - "domain_id" - "created" - "updated" - "display_name" - "prompt" title: "Prompt" description: "A prompt entity with configuration, metadata, and versioning." "404": description: "Prompt not found." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] delete: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "delete" x-cli-group: "prompts" x-cli-name: "delete" operationId: "DeletePrompt" summary: "Delete a prompt" parameters: - schema: type: "string" description: "Unique identifier of the prompt" required: true description: "Unique identifier of the prompt" name: "id" in: "path" responses: "200": description: "Prompt deleted." "404": description: "Prompt not found." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/prompts/{prompt_id}/versions: get: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "listVersions" x-cli-group: "prompts" x-cli-name: "listVersions" operationId: "ListPromptVersions" summary: "List all prompt versions" description: "Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first" parameters: - schema: type: "string" required: true name: "prompt_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Prompt versions retrieved." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: allOf: - type: "object" properties: _id: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "prompt" - type: "object" properties: timestamp: type: "string" required: - "timestamp" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] /v2/prompts/{prompt_id}/versions/{version_id}: get: tags: - "Prompts" x-speakeasy-group: "prompts" x-speakeasy-name-override: "getVersion" x-cli-group: "prompts" x-cli-name: "getVersion" operationId: "GetPromptVersion" summary: "Retrieve a prompt version" description: "Retrieves a specific version of a prompt by its ID and version ID." parameters: - schema: type: "string" description: "The unique identifier of the prompt" required: true description: "The unique identifier of the prompt" name: "prompt_id" in: "path" - schema: type: "string" description: "The unique identifier of the prompt version" required: true description: "The unique identifier of the prompt version" name: "version_id" in: "path" responses: "200": description: "Prompt version retrieved successfully." content: application/json: schema: allOf: - type: "object" properties: _id: type: "string" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" description: type: - "string" - "null" description: "The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose" prompt_config: type: "object" properties: stream: type: "boolean" model: type: - "string" - "null" model_db_id: type: - "string" - "null" model_type: type: - "string" - "null" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "vision" - null 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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "null" 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" - "slack" - "orq" - null 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" 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" required: - "messages" deprecated: true description: "[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema." prompt: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." 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: - "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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content." model: type: - "string" - "null" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`." example: "openai/gpt-4o" version: type: "string" title: "PromptField" description: "Prompt configuration with model and messages. Use this instead of prompt_config." metadata: type: "object" properties: use_cases: type: "array" items: type: "string" enum: - "Agents simulations" - "Agents" - "API interaction" - "Autonomous Agents" - "Chatbots" - "Classification" - "Code understanding" - "Code writing" - "Conversation" - "Documents QA" - "Evaluation" - "Extraction" - "Multi-modal" - "Self-checking" - "Sentiment analysis" - "SQL" - "Summarization" - "Tagging" - "Translation (document)" - "Translation (sentences)" description: "A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose" language: type: - "string" - "null" enum: - "Chinese" - "Dutch" - "English" - "French" - "German" - "Russian" - "Spanish" - null description: "The language that the prompt is written in. Use this field to categorize the prompt for your own purpose" default: language: "English" required: - "_id" - "prompt" - type: "object" properties: timestamp: type: "string" required: - "timestamp" "404": description: "Not Found - The prompt or prompt version does not exist." content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/tools: get: tags: - "Tools" x-speakeasy-group: "tools" x-speakeasy-name-override: "list" x-cli-group: "tools" x-cli-name: "list" operationId: "GetAllTools" summary: "List tools" description: "Lists all workspace tools. By default, returns all tools in a single response. Set `limit` to enable cursor-based pagination with `starting_after` and `ending_before`." parameters: - schema: type: "number" minimum: 1 maximum: 200 description: "Maximum number of tools per page (1-200). Omit to return all tools." required: false description: "Maximum number of tools per page (1-200). Omit to return all tools." name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Successfully retrieved the list of tools." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: oneOf: - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6N8FCK6AKW98HA63D5M" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "function" title: "Function Tool" description: "A custom function tool that allows the model to call predefined functions with structured parameters." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NA4BCRKEVQVATK9AN3" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "json_schema" title: "JSON Schema Tool" description: "A tool that enforces structured output format using JSON Schema for consistent response formatting." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NB564XF4BXHS3Z1CSM" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "http" title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services using customizable blueprints." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NDYDRFMGFMJDZHM1BZ" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6NEF09PJMAEJ9Z4Q2JH" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "mcp" title: "MCP Tool" description: "A tool from a Model Context Protocol (MCP) server that provides standardized access to external capabilities." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NFCY3BXAAG2DNDC8Q9" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "code_tool" title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment, currently supporting Python." has_more: type: "boolean" required: - "object" - "data" - "has_more" "401": description: "Unauthorized - Bearer token is missing or invalid." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] post: tags: - "Tools" x-speakeasy-group: "tools" x-speakeasy-name-override: "create" x-cli-group: "tools" x-cli-name: "create" operationId: "CreateTool" summary: "Create tool" description: "Creates a new tool in the workspace." requestBody: description: "The tool to create" content: application/json: schema: oneOf: - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" required: - "path" - "key" - "description" - "type" - "function" title: "Function Tool" description: "A custom function tool that allows the model to call predefined functions with structured parameters." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" required: - "path" - "key" - "description" - "type" - "json_schema" title: "JSON Schema Tool" description: "A tool that enforces structured output format using JSON Schema for consistent response formatting." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" required: - "path" - "key" - "description" - "type" - "http" title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services using customizable blueprints." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" required: - "server_url" - "connection_type" discovery_variables: type: "object" additionalProperties: type: "string" required: - "path" - "key" - "description" - "type" - "mcp" title: "MCP Tool" description: "A tool from a Model Context Protocol (MCP) server that provides standardized access to external capabilities." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" required: - "path" - "key" - "description" - "type" - "code_tool" title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment, currently supporting Python." responses: "200": description: "Successfully created the tool." content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NRMJQJS0QMV8SNES9K" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "function" title: "Function Tool" description: "A custom function tool that allows the model to call predefined functions with structured parameters." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NSCJA8YDGM0MA15ZHP" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "json_schema" title: "JSON Schema Tool" description: "A tool that enforces structured output format using JSON Schema for consistent response formatting." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NTRSEY1YXQYGX11FDA" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "http" title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services using customizable blueprints." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NWNA6CNP514YXQPNS2" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6NX3082M2AZZERKDBNS" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "mcp" title: "MCP Tool" description: "A tool from a Model Context Protocol (MCP) server that provides standardized access to external capabilities." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6NXNXMY9VE26B1P7ZVZ" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "code_tool" title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment, currently supporting Python." security: - ApiKey: [] /v2/tools/{tool_id}: patch: tags: - "Tools" x-speakeasy-group: "tools" x-speakeasy-name-override: "update" x-cli-group: "tools" x-cli-name: "update" operationId: "UpdateTool" summary: "Update tool" description: "Updates a tool in the workspace." parameters: - schema: type: "string" required: true name: "tool_id" in: "path" requestBody: description: "The tool to update" content: application/json: schema: oneOf: - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" required: - "type" title: "Update Function Tool" description: "Updates an existing function tool configuration." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" required: - "type" title: "Update JSON Schema Tool" description: "Updates an existing JSON Schema tool configuration." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" required: - "type" title: "Update HTTP Tool" description: "Updates an existing HTTP tool configuration." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6PPXK1R92K351A83Z3G" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true discovery_variables: type: "object" additionalProperties: type: "string" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" required: - "type" title: "Update MCP Tool" description: "Updates an existing MCP tool configuration." - type: "object" properties: path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" versionIncrement: type: "string" enum: - "major" - "minor" - "patch" versionDescription: type: "string" required: - "type" title: "Update Code Execution Tool" description: "Updates an existing code execution tool configuration." responses: "200": description: "Successfully updated the tool." content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6PBP9N70E5CZ3D3QM24" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "function" title: "Function Tool" description: "A custom function tool that allows the model to call predefined functions with structured parameters." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6PC99SB1JDGPEDRJ505" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "json_schema" title: "JSON Schema Tool" description: "A tool that enforces structured output format using JSON Schema for consistent response formatting." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6PDS40DX6Q2B17YCR4D" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "http" title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services using customizable blueprints." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6PF11H2DC7Q77NJHVNM" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6PG12DRB9EYH6ZCX8R5" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "mcp" title: "MCP Tool" description: "A tool from a Model Context Protocol (MCP) server that provides standardized access to external capabilities." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6PHJWW1HX64BQEFGSYK" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "code_tool" title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment, currently supporting Python." "404": description: "Tool not found." content: application/json: schema: type: "object" properties: error: type: "string" description: "Error message" required: - "error" example: error: "Tool with id my_tool not found" security: - ApiKey: [] delete: tags: - "Tools" x-speakeasy-group: "tools" x-speakeasy-name-override: "delete" x-cli-group: "tools" x-cli-name: "delete" operationId: "DeleteTool" summary: "Delete tool" description: "Deletes a tool by key." parameters: - schema: type: "string" required: true name: "tool_id" in: "path" responses: "200": description: "Successfully deleted the tool." security: - ApiKey: [] get: tags: - "Tools" x-speakeasy-group: "tools" x-speakeasy-name-override: "retrieve" x-cli-group: "tools" x-cli-name: "retrieve" operationId: "RetrieveTool" summary: "Retrieve tool" description: "Retrieves a tool by id." parameters: - schema: type: "string" required: true name: "tool_id" in: "path" responses: "200": description: "Successfully retrieved the tool." content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6Q091N2E4VHTA83JEZM" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "function" 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" description: "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models." parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." required: - "name" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "function" title: "Function Tool" description: "A custom function tool that allows the model to call predefined functions with structured parameters." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6Q18MSKTPWCCDM26WQ4" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: name: type: "string" minLength: 1 maxLength: 64 description: "The name of the response format. 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 response format is for. This will be shown to the user." schema: type: "object" properties: type: type: "string" description: "The JSON Schema type" properties: type: "object" additionalProperties: {} description: "The properties of the JSON Schema object" required: type: "array" items: type: "string" description: "Array of required property names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The schema for the response format, described as a JSON Schema object. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. Only compatible with `OpenAI` models." required: - "name" - "description" - "schema" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "json_schema" title: "JSON Schema Tool" description: "A tool that enforces structured output format using JSON Schema for consistent response formatting." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6Q3B3GX1Q91PZW841H5" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "http" http: type: "object" properties: blueprint: type: "object" properties: url: type: "string" description: "The URL to send the request to." method: type: "string" enum: - "GET" - "POST" - "PUT" - "DELETE" description: "The HTTP method to use." headers: type: "object" additionalProperties: anyOf: - type: "string" - type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: Content-Type: value: "application/json" encrypted: false description: "The headers to send with the request. Can be a string value or an object with value and encrypted properties." body: type: "object" additionalProperties: {} description: "The body to send with the request." timeout: type: "number" minimum: 1 maximum: 600 description: "The request timeout in seconds. Defaults to 60 seconds when not set. When used in an agent, tool executions are also bound by the agent run `limits.tool_timeout` (default 5 minutes), so raise that limit for longer-running tools." required: - "url" - "method" description: "The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields." arguments: type: "object" additionalProperties: type: "object" properties: type: type: "string" enum: - "string" - "number" - "boolean" description: "The type of the argument." description: type: "string" description: "A description of the argument." send_to_model: type: "boolean" default: true description: "Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank." default_value: anyOf: - type: "string" - type: "number" - type: "boolean" description: "The default value of the argument." required: - "type" - "description" description: "The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field." required: - "blueprint" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "http" title: "HTTP Tool" description: "Executes HTTP requests to interact with external APIs and web services using customizable blueprints." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6Q4KMCJEZE3N5WK6G4X" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "mcp" mcp: type: "object" properties: server_url: type: "string" format: "uri" description: "The MCP server URL (cached for execution)" headers: type: "object" additionalProperties: type: "object" properties: value: type: "string" encrypted: type: "boolean" default: false required: - "value" default: {} description: "HTTP headers for MCP server requests with encryption support" tools: type: "array" items: type: "object" properties: id: type: "string" default: "01KZEAE6Q53MBG6AG7D02KTZRE" name: type: "string" description: type: "string" schema: type: "object" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" required: - "type" required: - "name" - "schema" description: "Array of tools available from the MCP server" connection_type: type: "string" enum: - "http" - "sse" description: "The connection type used by the MCP server" template_variables: type: - "array" - "null" items: type: "string" description: "Names of template variables detected in server_url and headers. Used by the FE to prompt for one-time values on sync/refresh." readOnly: true required: - "server_url" - "tools" - "connection_type" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "mcp" title: "MCP Tool" description: "A tool from a Model Context Protocol (MCP) server that provides standardized access to external capabilities." - type: "object" properties: _id: type: "string" default: "tool_01KZEAE6Q60S94FJPFERXHC1AE" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" key: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z]([A-Za-z0-9]*([_-][A-Za-z0-9]+)*)?$" description: "Unique key of the tool as it will be displayed in the UI" display_name: type: "string" description: "The name of the tool as it will be displayed in the UI. This is optional and if not provided, the `key` will be used." description: type: "string" description: "A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision." created_by_id: type: - "string" - "null" description: "The id of the user that created the tool" updated_by_id: type: - "string" - "null" description: "The id of the user that last updated the tool" project_id: type: "string" workspace_id: type: "string" created: type: "string" updated: type: "string" status: type: "string" enum: - "live" - "draft" - "pending" - "published" default: "live" description: "The status of the tool. `Live` is the latest version of the tool. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version." type: type: "string" enum: - "code" code_tool: type: "object" properties: parameters: type: "object" properties: type: type: "string" enum: - "object" description: "The type must be \"object\"" properties: type: "object" additionalProperties: {} description: "The properties of the function parameters" required: type: "array" items: type: "string" description: "Array of required parameter names" required: - "type" - "properties" - "required" additionalProperties: {} description: "The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format." language: type: "string" enum: - "python" code: type: "string" minLength: 1 description: "The code to execute." required: - "language" - "code" required: - "path" - "key" - "description" - "project_id" - "workspace_id" - "created" - "updated" - "type" - "code_tool" title: "Code Execution Tool" description: "Executes code snippets in a sandboxed environment, currently supporting Python." security: - ApiKey: [] /v2/tools/{tool_id}/versions: get: tags: - "Tools" x-cli-group: "tools" x-cli-name: "listVersions" x-speakeasy-name-override: "listVersions" summary: "List tool versions" description: "Returns version history for a specific tool" parameters: - schema: type: "string" required: true name: "tool_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Tool versions retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" created_at: type: "string" updated_at: type: "string" created_by_id: type: "string" updated_by_id: type: "string" version: type: "string" description: type: "string" checksum: type: "string" entityType: type: "string" entityId: type: "string" data: type: "object" additionalProperties: {} workspace_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "version" - "checksum" - "entityType" - "entityId" - "data" - "workspace_id" has_more: type: "boolean" required: - "object" - "data" - "has_more" "404": description: "Tool not found" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/tools/{tool_id}/versions/{version_id}: get: tags: - "Tools" x-cli-group: "tools" x-cli-name: "getVersion" x-speakeasy-name-override: "getVersion" summary: "Get tool version" description: "Returns a specific version of a tool" parameters: - schema: type: "string" required: true name: "tool_id" in: "path" - schema: type: "string" required: true name: "version_id" in: "path" responses: "200": description: "Tool version retrieved" content: application/json: schema: type: "object" properties: _id: type: "string" created_at: type: "string" updated_at: type: "string" created_by_id: type: "string" updated_by_id: type: "string" version: type: "string" description: type: "string" checksum: type: "string" entityType: type: "string" entityId: type: "string" data: type: "object" additionalProperties: {} workspace_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "version" - "checksum" - "entityType" - "entityId" - "data" - "workspace_id" "404": description: "Tool or version not found" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/knowledge: get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "list" x-cli-group: "knowledge-bases" x-cli-name: "list" operationId: "ListKnowledgeBases" summary: "List all knowledge bases" description: "Returns a list of your knowledge bases. The knowledge bases are returned sorted by creation date, with the most recent knowledge bases appearing first" parameters: - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "integer" minimum: 1 maximum: 300 default: 25 description: "A limit on the number of objects to be returned. Limit can range between 1 and 300, and the default is 25" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 300, and the default is 25" name: "limit" in: "query" - schema: type: "string" description: "Filter knowledge bases by key (case-insensitive match)" required: false description: "Filter knowledge bases by key (case-insensitive match)" name: "search" in: "query" - schema: type: "string" description: "Filter by the users who last updated the knowledge base. Accepts a comma-separated list of user IDs" required: false description: "Filter by the users who last updated the knowledge base. Accepts a comma-separated list of user IDs" name: "updated_by" in: "query" - schema: type: "string" enum: - "internal" - "external" description: "Filter knowledge bases by type" required: false description: "Filter knowledge bases by type" name: "type" in: "query" - schema: type: "string" description: "Filter knowledge bases by project ID" required: false description: "Filter knowledge bases by project ID" name: "project_id" in: "query" responses: "200": description: "Knowledge bases retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: oneOf: - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "internal" default: "internal" retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." model: type: "string" description: "The embeddings model used for the knowledge base." required: - "_id" - "created" - "key" - "domain_id" - "updated" - "model" - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "external" default: "external" retrieval_settings: type: "object" properties: top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base." external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL of the external knowledge base." required: - "name" - "api_url" required: - "_id" - "created" - "key" - "domain_id" - "updated" - "external_config" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "create" x-cli-group: "knowledge-bases" x-cli-name: "create" operationId: "CreateKnowledge" summary: "Create a knowledge" requestBody: required: true content: application/json: schema: oneOf: - type: "object" properties: type: type: "string" enum: - "internal" default: "internal" key: type: "string" description: type: "string" embedding_model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base." retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" required: - "key" - "embedding_model" - "path" - type: "object" properties: type: type: "string" enum: - "external" default: "external" key: type: "string" description: type: "string" external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL of the external knowledge base." api_key: type: "string" description: "The API key to access the external knowledge base." required: - "name" - "api_url" - "api_key" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" required: - "key" - "external_config" - "path" responses: "200": description: "Knowledge successfully created" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "internal" default: "internal" retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." model: type: "string" description: "The embeddings model used for the knowledge base." required: - "_id" - "created" - "key" - "domain_id" - "updated" - "model" - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "external" default: "external" retrieval_settings: type: "object" properties: top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base." external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL of the external knowledge base." required: - "name" - "api_url" required: - "_id" - "created" - "key" - "domain_id" - "updated" - "external_config" security: - ApiKey: [] /v2/knowledge/{knowledge_id}: get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "retrieve" x-cli-group: "knowledge-bases" x-cli-name: "retrieve" operationId: "GetOneKnowledge" summary: "Retrieves a knowledge base" description: "Retrieve a knowledge base with the settings." parameters: - schema: type: "string" description: "Unique identifier of the knowledge base" required: true description: "Unique identifier of the knowledge base" name: "knowledge_id" in: "path" responses: "200": description: "Knowledge base retrieved" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "internal" default: "internal" retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." model: type: "string" description: "The embeddings model used for the knowledge base." required: - "_id" - "created" - "key" - "domain_id" - "updated" - "model" - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "external" default: "external" retrieval_settings: type: "object" properties: top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base." external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL of the external knowledge base." required: - "name" - "api_url" required: - "_id" - "created" - "key" - "domain_id" - "updated" - "external_config" "404": description: "Knowledge not found" security: - ApiKey: [] patch: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "update" x-cli-group: "knowledge-bases" x-cli-name: "update" operationId: "UpdateKnowledge" summary: "Updates a knowledge" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" requestBody: required: true content: application/json: schema: oneOf: - type: "object" properties: description: type: - "string" - "null" description: "The description of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" retrieval_settings: type: "object" properties: top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base." external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL for the external knowledge base." api_key: type: "string" description: "The API key for the external knowledge base." description: "Configuration for the external knowledge base." type: type: "string" enum: - "external" default: "external" - type: "object" properties: description: type: - "string" - "null" description: "The description of the knowledge base." embedding_model: type: "string" description: "The embeddings model used for the knowledge base. If the models is provided and is different than the previous set model, all the datasources in the knowledge base will be re-embedded." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." type: type: "string" enum: - "internal" default: "internal" responses: "200": description: "Knowledge successfully updated" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "internal" default: "internal" retrieval_settings: type: "object" properties: retrieval_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy." top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy." model: type: "string" description: "The embeddings model used for the knowledge base." required: - "_id" - "created" - "key" - "domain_id" - "updated" - "model" - type: "object" properties: _id: type: "string" description: "The unique identifier of the knowledge base." created: type: "string" description: "The creation date of the knowledge base." description: type: - "string" - "null" description: "The description of the knowledge base." key: type: "string" description: "The unique key of the knowledge base." domain_id: type: "string" description: "The project/domain ID of the knowledge base." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" created_by_id: type: - "string" - "null" format: "uuid" updated_by_id: type: - "string" - "null" format: "uuid" updated: type: "string" description: "The last update date of the knowledge base." type: type: "string" enum: - "external" default: "external" retrieval_settings: type: "object" properties: top_k: type: "integer" exclusiveMinimum: 0 default: 5 description: "The number of results to return from the search." threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned" rerank_config: type: - "object" - "null" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "The number of results to return by the reranking model" rerank_threshold: type: "number" minimum: 0 maximum: 1 default: 0.5 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" rerank_model: type: "string" description: "The rerank model to use for the knowledge base." required: - "rerank_model" description: "The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision." agentic_rag_config: type: - "object" - "null" properties: model: type: "string" description: "The model to use for the Agentic RAG" required: - "model" description: "The Agentic RAG configuration for the knowledge base. If `null` is provided, Agentic RAG will be disabled." description: "The retrieval settings for the knowledge base." external_config: type: "object" properties: name: type: "string" description: "The name of the external knowledge base." api_url: type: "string" format: "uri" description: "The API URL of the external knowledge base." required: - "name" - "api_url" required: - "_id" - "created" - "key" - "domain_id" - "updated" - "external_config" security: - ApiKey: [] delete: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "delete" x-cli-group: "knowledge-bases" x-cli-name: "delete" operationId: "DeleteKnowledge" description: "Deletes a knowledge base. Deleting a knowledge base will delete all the datasources and chunks associated with it." summary: "Deletes a knowledge" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" responses: "204": description: "Knowledge successfully deleted" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/search: post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "search" x-cli-group: "knowledge-bases" x-cli-name: "search" operationId: "SearchKnowledge" summary: "Search knowledge base" description: "Search a Knowledge Base and return the most similar chunks, along with their search and rerank scores. Note that all configuration changes made in the API will override the settings in the UI." parameters: - schema: type: "string" description: "The unique identifier or key of the knowledge base" required: true description: "The unique identifier or key of the knowledge base" name: "knowledge_id" in: "path" requestBody: description: "A search request for chunks in a knowledge base" content: application/json: schema: type: "object" properties: query: type: "string" minLength: 1 description: "The query to use to search the knowledge base" top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." required: - "query" responses: "200": description: "Search knowledge base" content: application/json: schema: type: "object" properties: matches: type: "array" items: type: "object" properties: id: type: "string" text: type: "string" vector: type: "array" items: type: "number" metadata: type: "object" additionalProperties: {} scores: type: "object" properties: rerank_score: type: "number" search_score: type: "number" required: - "id" - "text" required: - "matches" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources: get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "listDatasources" x-cli-group: "knowledge-bases" x-cli-name: "listDatasources" operationId: "ListDatasources" summary: "List all datasources" parameters: - schema: type: "string" description: "Unique identifier of the knowledge base" required: true description: "Unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Search query to find datasources by name." required: false description: "Search query to find datasources by name." name: "q" in: "query" - schema: type: "number" minimum: 1 maximum: 50 default: 50 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: anyOf: - type: "array" items: type: "string" example: - "completed" - "failed" - type: "string" example: "completed" description: "Filter datasources by status." required: false description: "Filter datasources by status." name: "status" in: "query" - schema: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" - type: "null" description: "Filter datasources by exact metadata key/value pairs. Provide a JSON-encoded object when calling this endpoint over HTTP." required: false description: "Filter datasources by exact metadata key/value pairs. Provide a JSON-encoded object when calling this endpoint over HTTP." name: "metadata" in: "query" responses: "200": description: "Datasources successfully retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" default: "01KZEAE6SPHV1QDKGRJN9P1F12" readOnly: true description: "The unique identifier of the data source" display_name: type: "string" description: "The display name of the datasource. Normally the name of the uploaded file" description: type: - "string" - "null" description: "The description of the knowledge base" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" file_id: type: - "string" - "null" description: "The unique identifier of the file used to create the datasource." created: type: "string" description: "The date and time the datasource was created" updated: type: "string" description: "The date and time the datasource was updated" created_by_id: type: - "string" - "null" description: "The user ID of the creator of the knowledge base" update_by_id: type: - "string" - "null" description: "The user ID of the last user who updated the knowledge base" knowledge_id: type: "string" description: "The unique identifier of the knowledge base" chunks_count: type: "number" description: "The number of chunks in the datasource" metadata: type: "object" properties: words_count: type: "number" description: "Number of words in the text" sentences_count: type: "number" description: "Number of sentences in the text" paragraphs_count: type: "number" description: "Number of paragraphs in the text" tokens_count: type: "number" description: "Number of tokens in the text" characters_count: type: "number" description: "Number of characters in the text" chunks_count: type: "number" description: "Number of total chunks" additionalProperties: {} required: - "display_name" - "status" - "created" - "updated" - "knowledge_id" - "chunks_count" - "metadata" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "createDatasource" x-cli-group: "knowledge-bases" x-cli-name: "createDatasource" operationId: "CreateDatasource" summary: "Create a new datasource" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" requestBody: required: true content: application/json: schema: type: "object" properties: display_name: type: "string" description: "The display name for the datasource visible in the UI. If omitted, the display name is derived from the uploaded file. When both `display_name` and `file_id` are provided, the provided `display_name` is prioritized." description: type: - "string" - "null" description: "The description of the knowledge base" metadata: type: "object" additionalProperties: {} description: "Client-defined metadata associated with the datasource." file_id: type: "string" description: "The unique identifier of the file used for datasource creation. If provided, the file is immediately queued for chunking." chunking_options: type: "object" properties: chunking_configuration: oneOf: - type: "object" properties: type: type: "string" enum: - "default" required: - "type" description: "Optimized chunking strategy focusing on speed and avoiding duplication of content chunks." - type: "object" properties: type: type: "string" enum: - "advanced" chunk_max_characters: type: "number" default: 500 description: "Defines the absolute maximum character length per chunk. Text elements exceeding this size will be automatically split into multiple chunks." chunk_overlap: type: "number" default: 0 description: "Specifies the number of characters to overlap between consecutive chunks. This overlap helps maintain semantic continuity when splitting large text elements." required: - "type" description: "Provides advanced settings for customizing chunking behavior, enabling fine-grained control to better meet specific data processing needs." description: "The chunking configuration settings for the datasource. Defaults to the system's standard chunking configuration if not specified." chunking_cleanup_options: type: "object" properties: delete_emails: type: "boolean" description: "Removes email addresses from the provided text." delete_credit_cards: type: "boolean" description: "Removes credit card numbers from the provided text." delete_phone_numbers: type: "boolean" description: "Removes phone numbers from the provided text." clean_bullet_points: type: "boolean" description: "Removes bullet points formatting from the text." clean_numbered_list: type: "boolean" description: "Removes numbered list formatting from the text." clean_unicode: type: "boolean" description: "Normalizes or removes unnecessary unicode characters from the text." clean_dashes: type: "boolean" description: "Normalizes or removes various dash characters to standardize the text." clean_whitespaces: type: "boolean" description: "Trims and normalizes excessive whitespace throughout the text." description: "The cleanup options applied to the datasource content. All options are enabled by default to ensure enhanced security and optimal chunk quality. Defaults to system-standard cleanup options if not specified." description: "Configuration options specifying how the datasource file is chunked. Required if `file_id` is specified. Defaults to standard chunking options if omitted." description: "The request body for creating a new datasource. If `file_id` is provided, the file is immediately queued for chunking." responses: "200": description: "Datasource successfully created" content: application/json: schema: type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" default: "01KZEAE6SSY892R3JQG8WZVFTF" readOnly: true description: "The unique identifier of the data source" display_name: type: "string" description: "The display name of the datasource. Normally the name of the uploaded file" description: type: - "string" - "null" description: "The description of the knowledge base" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" file_id: type: - "string" - "null" description: "The unique identifier of the file used to create the datasource." created: type: "string" description: "The date and time the datasource was created" updated: type: "string" description: "The date and time the datasource was updated" created_by_id: type: - "string" - "null" description: "The user ID of the creator of the knowledge base" update_by_id: type: - "string" - "null" description: "The user ID of the last user who updated the knowledge base" knowledge_id: type: "string" description: "The unique identifier of the knowledge base" chunks_count: type: "number" description: "The number of chunks in the datasource" metadata: type: "object" properties: words_count: type: "number" description: "Number of words in the text" sentences_count: type: "number" description: "Number of sentences in the text" paragraphs_count: type: "number" description: "Number of paragraphs in the text" tokens_count: type: "number" description: "Number of tokens in the text" characters_count: type: "number" description: "Number of characters in the text" chunks_count: type: "number" description: "Number of total chunks" additionalProperties: {} required: - "display_name" - "status" - "created" - "updated" - "knowledge_id" - "chunks_count" - "metadata" "500": description: "Failed to create datasource" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources/{datasource_id}: get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "retrieveDatasource" x-cli-group: "knowledge-bases" x-cli-name: "retrieveDatasource" operationId: "RetrieveDatasource" summary: "Retrieve a datasource" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" responses: "200": description: "Datasource successfully retrieved" content: application/json: schema: type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" default: "01KZEAE6SRCYDEQSCFKK0A7NWN" readOnly: true description: "The unique identifier of the data source" display_name: type: "string" description: "The display name of the datasource. Normally the name of the uploaded file" description: type: - "string" - "null" description: "The description of the knowledge base" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" file_id: type: - "string" - "null" description: "The unique identifier of the file used to create the datasource." created: type: "string" description: "The date and time the datasource was created" updated: type: "string" description: "The date and time the datasource was updated" created_by_id: type: - "string" - "null" description: "The user ID of the creator of the knowledge base" update_by_id: type: - "string" - "null" description: "The user ID of the last user who updated the knowledge base" knowledge_id: type: "string" description: "The unique identifier of the knowledge base" chunks_count: type: "number" description: "The number of chunks in the datasource" metadata: type: "object" properties: words_count: type: "number" description: "Number of words in the text" sentences_count: type: "number" description: "Number of sentences in the text" paragraphs_count: type: "number" description: "Number of paragraphs in the text" tokens_count: type: "number" description: "Number of tokens in the text" characters_count: type: "number" description: "Number of characters in the text" chunks_count: type: "number" description: "Number of total chunks" additionalProperties: {} required: - "display_name" - "status" - "created" - "updated" - "knowledge_id" - "chunks_count" - "metadata" security: - ApiKey: [] delete: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "deleteDatasource" x-cli-group: "knowledge-bases" x-cli-name: "deleteDatasource" operationId: "DeleteDatasource" description: "Deletes a datasource from a knowledge base. Deleting a datasource will remove it from the knowledge base and all associated chunks. This action is irreversible and cannot be undone." summary: "Deletes a datasource" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" responses: "204": description: "Datasource successfully deleted" security: - ApiKey: [] patch: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "updateDatasource" x-cli-group: "knowledge-bases" x-cli-name: "updateDatasource" operationId: "UpdateDatasource" summary: "Update a datasource" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" requestBody: required: true content: application/json: schema: type: "object" properties: display_name: type: "string" minLength: 1 required: - "display_name" responses: "200": description: "Datasource successfully updated" content: application/json: schema: type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" default: "01KZEAE6T3NAZNZBMQ6VAD96N4" readOnly: true description: "The unique identifier of the data source" display_name: type: "string" description: "The display name of the datasource. Normally the name of the uploaded file" description: type: - "string" - "null" description: "The description of the knowledge base" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" file_id: type: - "string" - "null" description: "The unique identifier of the file used to create the datasource." created: type: "string" description: "The date and time the datasource was created" updated: type: "string" description: "The date and time the datasource was updated" created_by_id: type: - "string" - "null" description: "The user ID of the creator of the knowledge base" update_by_id: type: - "string" - "null" description: "The user ID of the last user who updated the knowledge base" knowledge_id: type: "string" description: "The unique identifier of the knowledge base" chunks_count: type: "number" description: "The number of chunks in the datasource" metadata: type: "object" properties: words_count: type: "number" description: "Number of words in the text" sentences_count: type: "number" description: "Number of sentences in the text" paragraphs_count: type: "number" description: "Number of paragraphs in the text" tokens_count: type: "number" description: "Number of tokens in the text" characters_count: type: "number" description: "Number of characters in the text" chunks_count: type: "number" description: "Number of total chunks" additionalProperties: {} required: - "display_name" - "status" - "created" - "updated" - "knowledge_id" - "chunks_count" - "metadata" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks: post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "createChunks" x-cli-group: "knowledge-bases" x-cli-name: "createChunks" operationId: "CreateChunk" summary: "Create chunks for a datasource" parameters: - schema: type: "string" description: "Unique identifier of the knowledge" required: true description: "Unique identifier of the knowledge" name: "knowledge_id" in: "path" - schema: type: "string" description: "Unique identifier of the datasource" required: true description: "Unique identifier of the datasource" name: "datasource_id" in: "path" requestBody: content: application/json: schema: type: "array" items: type: "object" properties: text: type: "string" minLength: 1 description: "The text content of the chunk" embedding: type: "array" items: type: "number" description: "The embedding vector of the chunk. If not provided the chunk will be embedded with the knowledge base embeddings model." metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" description: "Metadata of the chunk" required: - "text" minItems: 1 maxItems: 100 description: "Array of chunks to create. Maximum of 100 chunks per request." responses: "200": description: "Chunk successfully created" content: application/json: schema: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the chunk" text: type: "string" description: "The text content of the chunk" metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" default: {} description: "Metadata of the chunk. Can include `page_number` or any other key-value pairs" enabled: type: "boolean" description: "Whether the chunk is enabled" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "The status of the chunk" created: type: "string" description: "The date and time the chunk was created" updated: type: "string" description: "The date and time the chunk was updated" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the chunk" update_by_id: type: - "string" - "null" description: "The unique identifier of the user who updated the chunk" required: - "_id" - "text" - "enabled" - "status" - "created" - "updated" description: "Array of created chunks" "500": description: "Failed to create chunk" security: - ApiKey: [] get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "listChunks" x-cli-group: "knowledge-bases" x-cli-name: "listChunks" operationId: "ListChunks" summary: "List all chunks for a datasource" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Search query to find datasources by name." required: false description: "Search query to find datasources by name." name: "q" in: "query" - schema: anyOf: - type: "array" items: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" example: - "completed" - "failed" - type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" example: "completed" description: "Filter chunks by status." required: false description: "Filter chunks by status." name: "status" in: "query" responses: "200": description: "Chunks successfully retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the chunk" text: type: "string" description: "The text content of the chunk" metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" default: {} description: "Metadata of the chunk. Can include `page_number` or any other key-value pairs" enabled: type: "boolean" description: "Whether the chunk is enabled" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "The status of the chunk" created: type: "string" description: "The date and time the chunk was created" updated: type: "string" description: "The date and time the chunk was updated" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the chunk" update_by_id: type: - "string" - "null" description: "The unique identifier of the user who updated the chunk" required: - "_id" - "text" - "enabled" - "status" - "created" - "updated" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] delete: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "deleteChunks" x-cli-group: "knowledge-bases" x-cli-name: "deleteChunks" operationId: "DeleteChunks" summary: "Delete multiple chunks" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: chunk_ids: type: "array" items: type: "string" minItems: 1 maxItems: 100 description: "Array of chunk IDs to delete" required: - "chunk_ids" responses: "200": description: "Chunks deletion result" content: application/json: schema: type: "object" properties: deleted_count: type: "number" description: "Number of chunks successfully deleted" failed_ids: type: "array" items: type: "string" description: "Array of chunk IDs that failed to delete" required: - "deleted_count" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/list: post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "listChunksPaginated" x-cli-group: "knowledge-bases" x-cli-name: "listChunksPaginated" operationId: "ListChunksPaginated" summary: "List chunks with offset-based pagination" parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: q: type: "string" default: "" description: "Search query to find chunks by text content" enabled: type: "boolean" description: "Filter chunks by enabled status" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "Filter chunks by processing status" limit: type: "integer" maximum: 200 minimum: 1 default: 100 page: type: "integer" default: 1 responses: "200": description: "Chunks successfully retrieved" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the chunk" text: type: "string" description: "The text content of the chunk" metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" default: {} description: "Metadata of the chunk. Can include `page_number` or any other key-value pairs" enabled: type: "boolean" description: "Whether the chunk is enabled" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "The status of the chunk" created: type: "string" description: "The date and time the chunk was created" updated: type: "string" description: "The date and time the chunk was updated" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the chunk" update_by_id: type: - "string" - "null" description: "The unique identifier of the user who updated the chunk" required: - "_id" - "text" - "enabled" - "status" - "created" - "updated" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/count: post: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "getChunksCount" x-cli-group: "knowledge-bases" x-cli-name: "getChunksCount" x-cli-hidden: true operationId: "GetChunksCount" summary: "Get chunks total count" description: "Returns the total count of chunks in a datasource. When `q` is provided, the count reflects indexed chunks only — recently created chunks may not be counted until embedding completes." parameters: - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" - schema: type: "string" description: "The unique identifier of the datasource." required: true description: "The unique identifier of the datasource." name: "datasource_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: q: type: "string" default: "" description: "Search query to find chunks by text content" enabled: type: "boolean" description: "Filter chunks by enabled status" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "Filter chunks by processing status" responses: "200": description: "Chunks count" content: application/json: schema: type: "object" properties: count: type: "number" required: - "count" security: - ApiKey: [] /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}: patch: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "updateChunk" x-cli-group: "knowledge-bases" x-cli-name: "updateChunk" operationId: "UpdateChunk" summary: "Update a chunk" parameters: - schema: type: "string" description: "The unique identifier of the chunk" required: true description: "The unique identifier of the chunk" name: "chunk_id" in: "path" - schema: type: "string" description: "The unique identifier of the data source" required: true description: "The unique identifier of the data source" name: "datasource_id" in: "path" - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: text: type: "string" minLength: 1 description: "The text content of the chunk" embedding: type: "array" items: type: "number" description: "The embedding vector of the chunk. If not provided the chunk will be embedded with the knowledge base embeddings model." metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" description: "Metadata of the chunk" responses: "200": description: "Chunk successfully updated" content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the chunk" text: type: "string" description: "The text content of the chunk" metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" default: {} description: "Metadata of the chunk. Can include `page_number` or any other key-value pairs" enabled: type: "boolean" description: "Whether the chunk is enabled" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "The status of the chunk" created: type: "string" description: "The date and time the chunk was created" updated: type: "string" description: "The date and time the chunk was updated" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the chunk" update_by_id: type: - "string" - "null" description: "The unique identifier of the user who updated the chunk" required: - "_id" - "text" - "enabled" - "status" - "created" - "updated" security: - ApiKey: [] delete: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "deleteChunk" x-cli-group: "knowledge-bases" x-cli-name: "deleteChunk" operationId: "DeleteChunk" summary: "Delete a chunk" parameters: - schema: type: "string" description: "The unique identifier of the chunk" required: true description: "The unique identifier of the chunk" name: "chunk_id" in: "path" - schema: type: "string" description: "The unique identifier of the data source" required: true description: "The unique identifier of the data source" name: "datasource_id" in: "path" - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" responses: "204": description: "Chunk successfully deleted" security: - ApiKey: [] get: tags: - "Knowledge Bases" x-speakeasy-group: "knowledge" x-speakeasy-name-override: "retrieveChunk" x-cli-group: "knowledge-bases" x-cli-name: "retrieveChunk" operationId: "GetOneChunk" summary: "Retrieve a chunk" parameters: - schema: type: "string" description: "The unique identifier of the chunk" required: true description: "The unique identifier of the chunk" name: "chunk_id" in: "path" - schema: type: "string" description: "The unique identifier of the data source" required: true description: "The unique identifier of the data source" name: "datasource_id" in: "path" - schema: type: "string" description: "The unique identifier of the knowledge base" required: true description: "The unique identifier of the knowledge base" name: "knowledge_id" in: "path" responses: "200": description: "Chunk successfully retrieved" content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the chunk" text: type: "string" description: "The text content of the chunk" metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" default: {} description: "Metadata of the chunk. Can include `page_number` or any other key-value pairs" enabled: type: "boolean" description: "Whether the chunk is enabled" status: type: "string" enum: - "pending" - "processing" - "completed" - "failed" - "queued" description: "The status of the chunk" created: type: "string" description: "The date and time the chunk was created" updated: type: "string" description: "The date and time the chunk was updated" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the chunk" update_by_id: type: - "string" - "null" description: "The unique identifier of the user who updated the chunk" required: - "_id" - "text" - "enabled" - "status" - "created" - "updated" security: - ApiKey: [] /v2/chunking: post: tags: - "Chunking" x-speakeasy-group: "chunking" x-speakeasy-name-override: "parse" x-cli-group: "chunking" x-cli-name: "parse" x-code-samples: - lang: "typescript" label: "Node.js" source: "import { Orq } from \"@orq-ai/node\";\n\nconst orq = new Orq({\n apiKey: process.env[\"ORQ_API_KEY\"]\n});\n\nconst result = await orq.chunking.parse({\n text: \"Your long text content here...\",\n strategy: \"semantic\",\n chunk_size: 256,\n threshold: 0.8,\n embedding_model: \"openai/text-embedding-3-small\",\n dimensions: 512\n});\n\nconsole.log(result.chunks);" - lang: "python" label: "Python" source: "from orq_ai_sdk import Orq\n\norq = Orq(api_key=os.getenv(\"ORQ_API_KEY\"))\n\nresult = orq.chunking.parse(\n text=\"Your long text content here...\",\n strategy=\"semantic\",\n chunk_size=256,\n threshold=0.8,\n embedding_model=\"openai/text-embedding-3-small\",\n dimensions=512\n)\n\nfor chunk in result.chunks:\n print(f\"Chunk {chunk.index}: {chunk.text[:50]}...\")" operationId: "parse" summary: "Parse text" description: "Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies." requestBody: required: true content: application/json: schema: oneOf: - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "token" title: "Token Chunker" chunk_size: type: "integer" exclusiveMinimum: 0 default: 512 description: "Maximum tokens per chunk" chunk_overlap: type: "integer" minimum: 0 default: 0 description: "Number of tokens to overlap between chunks" required: - "text" - "strategy" title: "Token Chunker Strategy" description: "Splits text based on token count. Best for ensuring chunks fit within LLM context windows and maintaining consistent chunk sizes for embedding models." - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "sentence" title: "Sentence Chunker" chunk_size: type: "integer" exclusiveMinimum: 0 default: 512 description: "Maximum tokens per chunk" chunk_overlap: type: "integer" minimum: 0 default: 0 description: "Number of overlapping tokens between chunks" min_sentences_per_chunk: type: "integer" exclusiveMinimum: 0 default: 1 description: "Minimum number of sentences per chunk" required: - "text" - "strategy" title: "Sentence Chunker Strategy" description: "Splits text at sentence boundaries while respecting token limits. Ideal for maintaining semantic coherence and readability." - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "recursive" title: "Recursive Chunker" chunk_size: type: "integer" exclusiveMinimum: 0 default: 512 description: "Maximum tokens per chunk" separators: type: "array" items: type: "string" default: - "\n\n" - "\n" - " " - "" description: "Hierarchy of separators to use for splitting" min_characters_per_chunk: type: "integer" exclusiveMinimum: 0 default: 24 description: "Minimum characters allowed per chunk" required: - "text" - "strategy" title: "Recursive Chunker Strategy" description: "Recursively splits text using a hierarchy of separators (paragraphs, sentences, words). Versatile general-purpose chunker that preserves document structure." - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "semantic" title: "Semantic Chunker" chunk_size: type: "integer" exclusiveMinimum: 0 default: 512 description: "Maximum tokens per chunk" threshold: anyOf: - type: "number" minimum: 0 maximum: 1 - type: "string" enum: - "auto" default: "auto" description: "Similarity threshold for grouping (0-1) or \"auto\" for automatic detection" embedding_model: type: "string" description: "Embedding model to use for semantic similarity. (Available embedding models)[https://docs.orq.ai/docs/proxy/supported-models#embedding-models]" dimensions: type: "integer" exclusiveMinimum: 0 description: "Number of dimensions for the embedding output. Required for text-embedding-3 models. Supported range: 256-3072 for text-embedding-3-large, 256-1536 for text-embedding-3-small." max_tokens: type: "integer" exclusiveMinimum: 0 description: "Maximum number of tokens per embedding request. Default is 8191 for text-embedding-3 models." mode: type: "string" enum: - "window" - "sentence" default: "window" description: "Chunking mode: window-based or sentence-based similarity" similarity_window: type: "integer" exclusiveMinimum: 0 default: 1 description: "Window size for similarity comparison" required: - "text" - "strategy" - "embedding_model" title: "Semantic Chunker Strategy" description: "Groups semantically similar sentences using embeddings. Excellent for maintaining topic coherence and context within chunks." - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "agentic" title: "Agentic Chunker" model: type: "string" description: "Model to use for chunking. (Available models)[https://docs.orq.ai/docs/proxy/supported-models#chat-models]" example: "openai/gpt-4.1" chunk_size: type: "integer" exclusiveMinimum: 0 default: 1024 description: "Maximum tokens per chunk" candidate_size: type: "integer" exclusiveMinimum: 0 default: 128 description: "Size of candidate splits for LLM evaluation" min_characters_per_chunk: type: "integer" exclusiveMinimum: 0 default: 24 description: "Minimum characters allowed per chunk" system_prompt: type: "string" description: "Custom system prompt for the agentic chunker LLM. Overrides the default prompt that instructs the model how to identify chunk boundaries. Maximum 20,000 tokens." required: - "text" - "strategy" - "model" title: "Agentic Chunker Strategy" description: "Agentic LLM-powered chunker that uses AI to determine optimal split points. Best for complex documents requiring intelligent segmentation." - type: "object" properties: text: type: "string" description: "The text content to be chunked" metadata: type: "boolean" default: true description: "Whether to include metadata for each chunk" return_type: type: "string" enum: - "chunks" - "texts" default: "chunks" description: "Return format: chunks (with metadata) or texts (plain strings)" strategy: type: "string" enum: - "fast" title: "Fast Chunker" target_size: type: "integer" exclusiveMinimum: 0 default: 4096 description: "Target chunk size in bytes" delimiters: type: "string" default: "\n.?" description: "Single-byte delimiter characters. Each character is treated as a separate delimiter (e.g., \".?!\" splits on period, question mark, or exclamation). Use escaped sequences for special chars." pattern: type: "string" description: "Multi-byte pattern for splitting (e.g., \"▁\" for SentencePiece tokenizers). Takes precedence over delimiters if set." prefix: type: "boolean" default: false description: "Attach delimiter to start of next chunk instead of end of current chunk" consecutive: type: "boolean" default: false description: "When true, splits at the START of consecutive delimiter runs, keeping the run with the following chunk (e.g., splits before \"\\n\\n\\n\" not in the middle)" forward_fallback: type: "boolean" default: false description: "Search forward if no delimiter found in backward search window" required: - "text" - "strategy" title: "Fast Chunker Strategy" description: "High-performance SIMD-optimized byte-level chunking. Best for large files (>1MB) where speed and memory efficiency are critical. 2x faster and 3x less memory than token-based chunking." title: "Chunking Request" description: "Request payload for text chunking with strategy-specific configuration" example: text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size." strategy: "semantic" chunk_size: 256 threshold: 0.8 embedding_model: "openai/text-embedding-3-small" dimensions: 512 mode: "window" similarity_window: 1 metadata: true responses: "200": description: "Text successfully chunked" content: application/json: schema: type: "object" properties: chunks: type: "array" items: type: "object" properties: text: type: "string" description: "The text content of the chunk" index: type: "number" description: "The position index of this chunk in the sequence" metadata: type: "object" properties: start_index: type: - "number" - "null" end_index: type: - "number" - "null" token_count: type: - "number" - "null" required: - "start_index" - "end_index" - "token_count" required: - "text" - "index" required: - "chunks" example: chunks: - id: "01HQ3K4M5N6P7Q8R9SATBVCWDX" text: "The quick brown fox jumps over the lazy dog." index: 0 metadata: start_index: 0 end_index: 44 token_count: 10 - id: "01HQ3K4M5N6P7Q8R9SATBVCWDY" text: "This is a sample text that will be chunked into smaller pieces." index: 1 metadata: start_index: 45 end_index: 108 token_count: 12 security: - ApiKey: [] /v2/memory-stores: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "list" x-cli-group: "memory-stores" x-cli-name: "list" operationId: "GetAllMemoryStores" summary: "List memory stores" description: "Retrieves a paginated list of memory stores in the workspace. Use cursor-based pagination parameters to navigate through the results." parameters: - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Filter memory stores by key (case-insensitive match)" required: false description: "Filter memory stores by key (case-insensitive match)" name: "search" in: "query" - schema: type: "string" description: "Filter by the users who last updated the memory store. Accepts a comma-separated list of user IDs" required: false description: "Filter by the users who last updated the memory store. Accepts a comma-separated list of user IDs" name: "updated_by" in: "query" - schema: type: "string" description: "Filter memory stores by project ID" required: false description: "Filter memory stores by project ID" name: "project_id" in: "query" responses: "200": description: "Successfully retrieved the list of memory stores." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the memory store" key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$" description: "The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace." description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." created_by_id: type: - "string" - "null" description: "The user ID of the creator" updated_by_id: type: - "string" - "null" description: "The user ID of the last updater" created: type: "string" description: "The creation date of the memory store" updated: type: "string" description: "The last update date of the memory store" ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." embedding_config: type: "object" properties: model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." required: - "model" required: - "_id" - "key" - "description" - "created" - "updated" - "embedding_config" has_more: type: "boolean" required: - "object" - "data" - "has_more" "401": description: "Unauthorized - Bearer token is missing or invalid." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] post: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "create" x-cli-group: "memory-stores" x-cli-name: "create" operationId: "CreateMemoryStore" summary: "Create memory store" requestBody: content: application/json: schema: type: "object" properties: key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$" description: "The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace." embedding_config: type: "object" properties: model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." required: - "model" description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" required: - "key" - "embedding_config" - "description" - "path" responses: "201": description: "Memory store successfully created with the specified configuration." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the memory store" key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$" description: "The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace." description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." created_by_id: type: - "string" - "null" description: "The user ID of the creator" updated_by_id: type: - "string" - "null" description: "The user ID of the last updater" created: type: "string" description: "The creation date of the memory store" updated: type: "string" description: "The last update date of the memory store" ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." embedding_config: type: "object" properties: model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." required: - "model" required: - "_id" - "key" - "description" - "created" - "updated" - "embedding_config" security: - ApiKey: [] /v2/memory-stores/{memory_store_key}: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "retrieve" x-cli-group: "memory-stores" x-cli-name: "retrieve" operationId: "RetrieveMemoryStore" summary: "Retrieve memory store" description: "Retrieves detailed information about a specific memory store, including its configuration and metadata." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" responses: "200": description: "Memory store details successfully retrieved." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the memory store" key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$" description: "The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace." description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." created_by_id: type: - "string" - "null" description: "The user ID of the creator" updated_by_id: type: - "string" - "null" description: "The user ID of the last updater" created: type: "string" description: "The creation date of the memory store" updated: type: "string" description: "The last update date of the memory store" ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." embedding_config: type: "object" properties: model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." required: - "model" required: - "_id" - "key" - "description" - "created" - "updated" - "embedding_config" "401": description: "Unauthorized - Bearer token is missing or invalid." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" "403": description: "Forbidden - Insufficient permissions to access this memory store." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" "404": description: "Memory store not found." content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] patch: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "update" x-cli-group: "memory-stores" x-cli-name: "update" operationId: "UpdateMemoryStore" summary: "Update memory store" description: "Update the memory store configuration" parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" requestBody: content: application/json: schema: type: "object" properties: description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." path: type: "string" responses: "200": description: "Memory store successfully updated." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the memory store" key: type: "string" minLength: 1 maxLength: 255 pattern: "^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$" description: "The unique key of the memory store. The key is unique and inmmutable and cannot be repeated within the same workspace." description: type: "string" description: "The description of the memory store. Be as precise as possible to help the AI to understand the purpose of the memory store." created_by_id: type: - "string" - "null" description: "The user ID of the creator" updated_by_id: type: - "string" - "null" description: "The user ID of the last updater" created: type: "string" description: "The creation date of the memory store" updated: type: "string" description: "The last update date of the memory store" ttl: type: - "number" - "null" description: "The default time to live of every memory document created within the memory store. Useful to control if the documents in the memory should be store for short or long term." embedding_config: type: "object" properties: model: type: "string" description: "The embeddings model to use for the knowledge base in the format \"provider/model\" for public models or \"workspaceKey@provider/model\" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." required: - "model" required: - "_id" - "key" - "description" - "created" - "updated" - "embedding_config" "400": description: "Bad Request - Invalid update data provided" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to update memory store" "404": description: "Memory store not found" security: - ApiKey: [] delete: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "delete" x-cli-group: "memory-stores" x-cli-name: "delete" operationId: "DeleteMemoryStore" summary: "Delete memory store" description: "Permanently delete a memory store, including memories and documents." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" responses: "204": description: "Memory store successfully deleted." "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to delete memory store" "404": description: "Memory store not found" security: - ApiKey: [] /v2/memory-stores/{memory_store_key}/memories: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "listMemories" x-cli-group: "memory-stores" x-cli-name: "listMemories" operationId: "GetAllMemories" summary: "List all memories" description: "Retrieves a paginated list of memories for the memory store" parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Search query to filter memories by entity_id" required: false description: "Search query to filter memories by entity_id" name: "q" in: "query" responses: "200": description: "Successfully retrieved the list of memories." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "Unique identifier for the memory. This is automatically generated by the system." entity_id: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z0-9]+(?:[_-][A-Za-z0-9]+)*$" deprecated: true description: "Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" store_id: type: "string" workspace_id: type: "string" documents_count: type: "number" description: "The number of memories in the entity" required: - "_id" - "entity_id" - "created" - "updated" - "store_id" - "workspace_id" - "documents_count" has_more: type: "boolean" required: - "object" - "data" - "has_more" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to access memories" security: - ApiKey: [] post: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "createMemory" x-cli-group: "memory-stores" x-cli-name: "createMemory" operationId: "CreateMemory" summary: "Create a new memory" description: "Creates a new memory in the specified memory store." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" requestBody: content: application/json: schema: type: "object" properties: entity_id: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z0-9]+(?:[_-][A-Za-z0-9]+)*$" description: "Unique identifier for the entity this memory is associated with (e.g., user ID, session ID, conversation ID)." required: - "entity_id" responses: "201": description: "Memory successfully created." content: application/json: schema: type: "object" properties: _id: type: "string" description: "Unique identifier for the memory. This is automatically generated by the system." entity_id: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z0-9]+(?:[_-][A-Za-z0-9]+)*$" deprecated: true description: "Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" store_id: type: "string" workspace_id: type: "string" documents_count: type: "number" description: "The number of memories in the entity" required: - "_id" - "entity_id" - "created" - "updated" - "store_id" - "workspace_id" - "documents_count" "400": description: "Bad Request - Invalid memory data provided" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to create memories" security: - ApiKey: [] /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "retrieveMemory" x-cli-group: "memory-stores" x-cli-name: "retrieveMemory" operationId: "RetrieveMemory" summary: "Retrieve a specific memory" description: "Retrieves details of a specific memory by its ID" parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" responses: "200": description: "Memory successfully retrieved." content: application/json: schema: type: "object" properties: _id: type: "string" description: "Unique identifier for the memory. This is automatically generated by the system." entity_id: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z0-9]+(?:[_-][A-Za-z0-9]+)*$" deprecated: true description: "Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" store_id: type: "string" workspace_id: type: "string" documents_count: type: "number" description: "The number of memories in the entity" required: - "_id" - "entity_id" - "created" - "updated" - "store_id" - "workspace_id" - "documents_count" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to access memory" "404": description: "Memory not found" security: - ApiKey: [] patch: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "updateMemory" x-cli-group: "memory-stores" x-cli-name: "updateMemory" operationId: "UpdateMemory" summary: "Update a specific memory" description: "Updates the details of a specific memory." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: metadata: type: "object" additionalProperties: type: "string" responses: "200": description: "Memory successfully updated." content: application/json: schema: type: "object" properties: _id: type: "string" description: "Unique identifier for the memory. This is automatically generated by the system." entity_id: type: "string" minLength: 1 maxLength: 64 pattern: "^[A-Za-z0-9]+(?:[_-][A-Za-z0-9]+)*$" deprecated: true description: "Customer provided entity ID for the memory. This is used to link the memory to a specific user/company/session/etc. Has to be unique within the memory store." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" store_id: type: "string" workspace_id: type: "string" documents_count: type: "number" description: "The number of memories in the entity" required: - "_id" - "entity_id" - "created" - "updated" - "store_id" - "workspace_id" - "documents_count" "400": description: "Bad Request - Invalid update data provided" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to update memory" "404": description: "Memory not found" security: - ApiKey: [] delete: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "deleteMemory" x-cli-group: "memory-stores" x-cli-name: "deleteMemory" operationId: "DeleteMemory" summary: "Delete a specific memory" description: "Permanently deletes a specific memory.\n\n Use this endpoint to:\n - Remove a memory from the store\n - Clean up unused memories\n - Manage memory storage space" parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" responses: "204": description: "Memory successfully deleted." "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to delete memory" "404": description: "Memory not found" security: - ApiKey: [] /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "listDocuments" x-cli-group: "memory-stores" x-cli-name: "listDocuments" operationId: "GetAllMemoryDocuments" summary: "List all documents for a memory" description: "Retrieves a paginated list of documents associated with a specific memory." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" format: "date-time" description: "Filter documents updated after this ISO datetime" required: false description: "Filter documents updated after this ISO datetime" name: "updated_after" in: "query" - schema: type: "string" format: "date-time" description: "Filter documents updated before this ISO datetime" required: false description: "Filter documents updated before this ISO datetime" name: "updated_before" in: "query" responses: "200": description: "Successfully retrieved the list of memory documents." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" memory_id: type: "string" store_id: type: "string" text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" workspace_id: type: "string" metadata: type: "object" additionalProperties: type: "string" default: {} description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." required: - "_id" - "memory_id" - "store_id" - "text" - "created" - "updated" - "workspace_id" has_more: type: "boolean" required: - "object" - "data" - "has_more" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to access memory documents" "404": description: "Memory not found" security: - ApiKey: [] post: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "createDocument" x-cli-group: "memory-stores" x-cli-name: "createDocument" operationId: "CreateMemoryDocument" summary: "Create a new memory document" description: "Creates a new document in the specified memory." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique entity_id provided during the memory store creation" required: true description: "The unique entity_id provided during the memory store creation" name: "memory_entity_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." metadata: type: "object" additionalProperties: type: "string" description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." required: - "text" responses: "201": description: "Memory document successfully created." content: application/json: schema: type: "object" properties: _id: type: "string" memory_id: type: "string" store_id: type: "string" text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" workspace_id: type: "string" metadata: type: "object" additionalProperties: type: "string" default: {} description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." required: - "_id" - "memory_id" - "store_id" - "text" - "created" - "updated" - "workspace_id" "400": description: "Bad Request - Invalid document data provided" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to create documents" "404": description: "Memory not found" security: - ApiKey: [] /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}: get: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "retrieveDocument" x-cli-group: "memory-stores" x-cli-name: "retrieveDocument" operationId: "RetrieveMemoryDocument" summary: "Retrieve a specific memory document" description: "Retrieves details of a specific memory document by its ID." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" - schema: type: "string" description: "The unique identifier of the document" required: true description: "The unique identifier of the document" name: "document_id" in: "path" responses: "200": description: "Memory document successfully retrieved." content: application/json: schema: type: "object" properties: _id: type: "string" memory_id: type: "string" store_id: type: "string" text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" workspace_id: type: "string" metadata: type: "object" additionalProperties: type: "string" default: {} description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." required: - "_id" - "memory_id" - "store_id" - "text" - "created" - "updated" - "workspace_id" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to access document" "404": description: "Document not found" security: - ApiKey: [] patch: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "updateDocument" x-cli-group: "memory-stores" x-cli-name: "updateDocument" operationId: "UpdateMemoryDocument" summary: "Update a specific memory document" description: "Updates the details of a specific memory document." parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" - schema: type: "string" description: "The unique identifier of the document" required: true description: "The unique identifier of the document" name: "document_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." metadata: type: "object" additionalProperties: type: "string" description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." responses: "200": description: "Memory document successfully updated." content: application/json: schema: type: "object" properties: _id: type: "string" memory_id: type: "string" store_id: type: "string" text: type: "string" minLength: 1 description: "The content of the memory document (whitespace trimmed)." created: type: "string" updated: type: "string" created_by_id: type: - "string" - "null" updated_by_id: type: - "string" - "null" workspace_id: type: "string" metadata: type: "object" additionalProperties: type: "string" default: {} description: "Flexible key-value pairs for custom filtering and categorization. Clients can add arbitrary string metadata to enable future filtering of memory documents based on their specific needs (e.g., document type, source, topic, relevance score, or any custom taxonomy)." required: - "_id" - "memory_id" - "store_id" - "text" - "created" - "updated" - "workspace_id" "400": description: "Bad Request - Invalid update data provided" "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to update document" "404": description: "Document not found" security: - ApiKey: [] delete: tags: - "Memory Stores" x-speakeasy-group: "memoryStores" x-speakeasy-name-override: "deleteDocument" x-cli-group: "memory-stores" x-cli-name: "deleteDocument" operationId: "DeleteMemoryDocument" summary: "Delete a specific memory document" description: "Permanently deletes a specific memory document.\n\n Use this endpoint to:\n - Remove a document from a memory\n - Clean up unused documents\n - Manage document storage space" parameters: - schema: type: "string" description: "The unique key identifier of the memory store" required: true description: "The unique key identifier of the memory store" name: "memory_store_key" in: "path" - schema: type: "string" description: "The unique identifier of the memory" required: true description: "The unique identifier of the memory" name: "memory_entity_id" in: "path" - schema: type: "string" description: "The unique identifier of the document" required: true description: "The unique identifier of the document" name: "document_id" in: "path" responses: "204": description: "Memory document successfully deleted." "401": description: "Unauthorized - Bearer token is missing or invalid" "403": description: "Forbidden - Insufficient permissions to delete document" "404": description: "Document not found" security: - ApiKey: [] /v2/datasets: get: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "list" x-cli-group: "datasets" x-cli-name: "list" operationId: "ListDatasets" summary: "List datasets" description: "Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination." parameters: - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Filter datasets by display name (case-insensitive match)." required: false description: "Filter datasets by display name (case-insensitive match)." name: "search" in: "query" - schema: type: "string" description: "Comma-separated list of user IDs; returns datasets last updated by any of them." required: false description: "Comma-separated list of user IDs; returns datasets last updated by any of them." name: "updated_by" in: "query" responses: "200": description: "Datasets Retrieved Successfully" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the project it belongs to" workspace_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the workspace it belongs to" metadata: type: "object" properties: total_versions: type: "number" datapoints_count: type: "number" required: - "total_versions" - "datapoints_count" created_by_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 unique identifier of the user who created the dataset" updated_by_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 unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "project_id" - "workspace_id" - "metadata" has_more: type: "boolean" required: - "object" - "data" - "has_more" security: - ApiKey: [] post: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "create" x-cli-group: "datasets" x-cli-name: "create" operationId: "CreateDataset" summary: "Create a dataset" description: "Creates a new dataset in the specified project." requestBody: content: application/json: schema: type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" required: - "display_name" - "path" responses: "200": description: "Dataset created successfully. Returns the newly created dataset object." content: application/json: schema: type: "object" properties: _id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the project it belongs to" workspace_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the workspace it belongs to" metadata: type: "object" properties: total_versions: type: "number" datapoints_count: type: "number" required: - "total_versions" - "datapoints_count" created_by_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 unique identifier of the user who created the dataset" updated_by_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 unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "project_id" - "workspace_id" - "metadata" security: - ApiKey: [] /v2/datasets/{dataset_id}: get: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "retrieve" x-cli-group: "datasets" x-cli-name: "retrieve" operationId: "RetrieveDataset" summary: "Retrieve a dataset" description: "Retrieves a specific dataset by its unique identifier" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" responses: "200": description: "Dataset retrieved successfully. Returns the complete dataset object." content: application/json: schema: type: "object" properties: _id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the project it belongs to" workspace_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the workspace it belongs to" metadata: type: "object" properties: total_versions: type: "number" datapoints_count: type: "number" required: - "total_versions" - "datapoints_count" created_by_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 unique identifier of the user who created the dataset" updated_by_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 unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "project_id" - "workspace_id" - "metadata" "404": description: "Dataset not found with the given id" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] patch: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "update" x-cli-group: "datasets" x-cli-name: "update" operationId: "UpdateDataset" description: "Update a dataset" summary: "Update a dataset" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the project it belongs to" path: type: "string" description: "Entity storage path.\n\nWith workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.\n\nWith project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project." example: "Default" responses: "200": description: "Dataset updated." content: application/json: schema: type: "object" properties: _id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" display_name: type: "string" minLength: 1 maxLength: 128 description: "The display name of the dataset" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the project it belongs to" workspace_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the workspace it belongs to" metadata: type: "object" properties: total_versions: type: "number" datapoints_count: type: "number" required: - "total_versions" - "datapoints_count" created_by_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 unique identifier of the user who created the dataset" updated_by_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 unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "project_id" - "workspace_id" - "metadata" "404": description: "Dataset not found with the given id" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] delete: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "delete" x-cli-group: "datasets" x-cli-name: "delete" operationId: "DeleteDataset" summary: "Delete a dataset" description: "Permanently deletes a dataset and all its datapoints. This action is irreversible." parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" responses: "204": description: "No content - Dataset successfully deleted" "404": description: "Dataset not found - The specified dataset does not exist or has already been deleted" security: - ApiKey: [] /v2/datasets/{dataset_id}/datapoints: get: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "listDatapoints" x-cli-group: "datasets" x-cli-name: "listDatapoints" operationId: "ListDatasetDatapoints" summary: "List datapoints" description: "Retrieves a paginated list of datapoints from a specific dataset." parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Datapoints retrieved successfully. Returns a paginated list of datapoints." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the dataset item" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" inputs: type: "object" additionalProperties: {} description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" evaluations: type: "array" items: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.897Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.898Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.899Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.899Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the datapoint" dataset_id: type: "string" description: "The unique identifier of the dataset" snapshot_version: type: "string" description: "The version of the dataset snapshot" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the dataset" updated_by_id: type: - "string" - "null" description: "The unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "workspace_id" - "dataset_id" has_more: type: "boolean" required: - "object" - "data" - "has_more" "404": description: "Dataset not found" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] post: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "createDatapoint" x-cli-group: "datasets" x-cli-name: "createDatapoint" operationId: "CreateDatasetItem" summary: "Create a datapoint" description: "Creates a new datapoint in the specified dataset." parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" requestBody: content: application/json: schema: type: "array" items: type: "object" properties: inputs: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" - type: "null" description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects and arrays are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" minItems: 1 maxItems: 5000 description: "An array of datapoints to create (min 1, max 5000)" responses: "200": description: "Datapoints created successfully. Returns an array of newly created datapoint objects." content: application/json: schema: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the dataset item" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" inputs: type: "object" additionalProperties: {} description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" evaluations: type: "array" items: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.911Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.912Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.912Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.913Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the datapoint" dataset_id: type: "string" description: "The unique identifier of the dataset" snapshot_version: type: "string" description: "The version of the dataset snapshot" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the dataset" updated_by_id: type: - "string" - "null" description: "The unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "workspace_id" - "dataset_id" security: - ApiKey: [] /v2/datasets/{dataset_id}/datapoints/{datapoint_id}: get: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "retrieveDatapoint" x-cli-group: "datasets" x-cli-name: "retrieveDatapoint" operationId: "RetrieveDatapoint" summary: "Retrieve a datapoint" description: "Retrieves a datapoint object" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" - schema: type: "string" description: "The unique identifier of the datapoint" required: true description: "The unique identifier of the datapoint" name: "datapoint_id" in: "path" responses: "200": description: "Datapoint retrieved." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the dataset item" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" inputs: type: "object" additionalProperties: {} description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" evaluations: type: "array" items: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.904Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.905Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.906Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.906Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the datapoint" dataset_id: type: "string" description: "The unique identifier of the dataset" snapshot_version: type: "string" description: "The version of the dataset snapshot" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the dataset" updated_by_id: type: - "string" - "null" description: "The unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "workspace_id" - "dataset_id" "404": description: "Datapoint not found" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] patch: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "updateDatapoint" x-cli-group: "datasets" x-cli-name: "updateDatapoint" operationId: "UpdateDatapoint" summary: "Update a datapoint" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" - schema: type: "string" description: "The unique identifier of the datapoint" required: true description: "The unique identifier of the datapoint" name: "datapoint_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: inputs: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" - type: "null" description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects and arrays are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" responses: "200": description: "Dataset item updated." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the dataset item" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" inputs: type: "object" additionalProperties: {} description: "The inputs of the dataset. Key value pairs where the key is the input name and the value is the input value. Nested objects are not supported." 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far" expected_output: type: "string" evaluations: type: "array" items: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.943Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.944Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.944Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:06.945Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the datapoint" dataset_id: type: "string" description: "The unique identifier of the dataset" snapshot_version: type: "string" description: "The version of the dataset snapshot" created_by_id: type: - "string" - "null" description: "The unique identifier of the user who created the dataset" updated_by_id: type: - "string" - "null" description: "The unique identifier of the user who last updated the dataset" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "workspace_id" - "dataset_id" "404": description: "Dataset item not found" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] delete: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "deleteDatapoint" x-cli-group: "datasets" x-cli-name: "deleteDatapoint" operationId: "DeleteDatapoint" summary: "Delete a datapoint" description: "Permanently deletes a specific datapoint from a dataset." parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" - schema: type: "string" description: "The unique identifier of the datapoint" required: true description: "The unique identifier of the datapoint" name: "datapoint_id" in: "path" responses: "204": description: "No content - Datapoint successfully deleted" "404": description: "Datapoint not found - The specified datapoint does not exist or has already been deleted" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] /v2/datasets/{dataset_id}/clear: delete: tags: - "Datasets" x-speakeasy-group: "datasets" x-speakeasy-name-override: "clear" x-cli-group: "datasets" x-cli-name: "clear" operationId: "ClearDataset" description: "Delete all datapoints from a dataset. This action is irreversible." summary: "Delete all datapoints" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "The unique identifier of the dataset" required: true description: "The unique identifier of the dataset" name: "dataset_id" in: "path" responses: "204": description: "No content - successful operation" "404": description: "Dataset not found with the given id" content: application/json: schema: $ref: "#/components/schemas/HonoApiError" security: - ApiKey: [] /v2/router/chat/completions: post: tags: - "Chat" x-speakeasy-group: "router.chat.completions" x-speakeasy-name-override: "create" x-cli-group: "chat" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" operationId: "createChatCompletion" summary: "Create chat completion" description: "Creates a model response for the given chat conversation with support for retries, fallbacks, prompts, and variables." requestBody: required: true content: application/json: schema: allOf: - type: "object" properties: 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far." model: type: "string" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." metadata: type: "object" additionalProperties: type: "string" maxLength: 512 description: "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can have a maximum length of 64 characters and values can have a maximum length of 512 characters." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." 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 call." 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" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" additionalProperties: type: "boolean" required: - "type" - "properties" description: "The parameters the functions accepts, described as a JSON Schema object" strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the function call. " required: - "name" required: - "function" description: "A list of tools the model may call." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." variables: type: "object" additionalProperties: {} description: "Variables to substitute in message templates. Uses f-string syntax ({{variableName}}) by default. For advanced templating with Jinja or Mustache syntax, use in conjunction with `template_engine`." example: customer_name: "John Smith" product_name: "Premium Plan" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" inputs: anyOf: - type: "object" additionalProperties: {} - type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" required: - "key" deprecated: true description: "@deprecated Use top-level `variables` field instead. Values to replace in the prompt messages using {{variableName}} syntax." example: customer_name: "John Smith" product_name: "Premium Plan" issue_type: "billing" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." knowledge_bases: type: "array" items: type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" query: type: "string" description: "The query to use to search the knowledge base. If not provided we will use the last user message from the messages of the requests" required: - "knowledge_id" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." description: "Leverage Orq's intelligent routing capabilities to enhance your AI application with enterprise-grade reliability and observability. Orq provides automatic request management including retries on failures, model fallbacks for high availability, identity-level analytics tracking, conversation threading, and dynamic prompt templating with variable substitution." deprecated: true example: retry: count: 3 on_codes: - 429 - 500 - 502 fallbacks: - model: "openai/gpt-5" - model: "anthropic/claude-4-opus" identity: id: "identity_01ARZ3NDEKTSV4RRFFQ69G5FAV" display_name: "Jane Doe" email: "jane.doe@example.com" thread: id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: - "customer-support" inputs: customer_name: "John Smith" issue_type: "billing" cache: ttl: 3600 type: "exact_match" knowledge_bases: - knowledge_id: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV" top_k: 5 timeout: call_timeout: 30000 security: mask: - "input" - "system" required: - "messages" - "model" - type: "object" properties: stream: type: "boolean" default: false responses: "200": description: "Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed." content: application/json: schema: type: "object" properties: id: type: "string" description: "A unique identifier for the chat completion." choices: type: "array" items: type: "object" properties: finish_reason: type: - "string" - "null" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - null description: "The reason the model stopped generating tokens." index: type: "number" default: 0 description: "The index of the choice in the list of choices." message: type: "object" properties: content: type: - "string" - "null" refusal: type: - "string" - "null" tool_calls: type: "array" items: type: "object" properties: index: type: "number" id: type: "string" type: type: "string" enum: - "function" 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." 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." role: type: "string" enum: - "assistant" reasoning: type: - "string" - "null" description: "Internal thought process of the model" reasoning_signature: type: - "string" - "null" 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." audio: type: - "object" - "null" properties: id: type: "string" expires_at: type: "integer" data: type: "string" transcript: type: "string" required: - "id" - "expires_at" - "data" - "transcript" description: "If the audio output modality is requested, this object contains data about the audio response from the model." description: "A chat completion message generated by the model." logprobs: type: - "object" - "null" properties: content: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message content tokens with log probability information." refusal: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message refusal tokens with log probability information." required: - "content" - "refusal" description: "Log probability information for the choice." required: - "finish_reason" - "message" description: "A list of chat completion choices. Can be more than one if n is greater than 1." created: type: "number" description: "The Unix timestamp (in seconds) of when the chat completion was created." model: type: "string" description: "The model used for the chat completion." system_fingerprint: type: - "string" - "null" description: "This fingerprint represents the backend configuration that the model runs with." usage: type: - "object" - "null" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Usage statistics for the completion request." object: type: "string" enum: - "chat.completion" required: - "id" - "choices" - "created" - "model" - "object" description: "Represents a chat completion response returned by model, based on the provided input." text/event-stream: schema: type: "object" properties: data: type: object properties: id: type: string description: A unique identifier for the chat completion. choices: type: array items: type: object properties: finish_reason: type: - string - "null" enum: - stop - length - tool_calls - content_filter - function_call - null description: The reason the model stopped generating tokens. index: type: number default: 0 description: The index of the choice in the list of choices. logprobs: type: - object - "null" properties: content: type: - array - "null" items: type: object properties: token: type: string description: The token. logprob: type: number description: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. bytes: type: - array - "null" items: type: number description: A list of integers representing the UTF-8 bytes representation of the token. top_logprobs: type: array items: type: object properties: token: type: string description: The token. logprob: type: number description: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. bytes: type: - array - "null" items: type: number description: A list of integers representing the UTF-8 bytes representation of the token. required: - token - logprob - bytes description: List of the most likely tokens and their log probability, at this token position. required: - token - logprob - bytes - top_logprobs description: A list of message content tokens with log probability information. refusal: type: - array - "null" items: type: object properties: token: type: string description: The token. logprob: type: number description: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. bytes: type: - array - "null" items: type: number description: A list of integers representing the UTF-8 bytes representation of the token. top_logprobs: type: array items: type: object properties: token: type: string description: The token. logprob: type: number description: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. bytes: type: - array - "null" items: type: number description: A list of integers representing the UTF-8 bytes representation of the token. required: - token - logprob - bytes description: List of the most likely tokens and their log probability, at this token position. required: - token - logprob - bytes - top_logprobs description: A list of message refusal tokens with log probability information. required: - content - refusal description: Log probability information for the choice. delta: type: object properties: content: type: - string - "null" description: The contents of the chunk message. refusal: type: - string - "null" tool_calls: type: array items: type: object properties: index: type: number description: The index of the tool call. 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. 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. role: type: string enum: - assistant 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. audio: type: - object - "null" properties: id: type: string transcript: type: string data: type: string expires_at: type: integer description: Audio response data in streaming mode. description: A chat completion delta generated by streamed model responses. required: - finish_reason - delta description: 'A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.' created: type: number description: The Unix timestamp (in seconds) of when the chat completion was created. model: type: string description: The model used for the chat completion. system_fingerprint: type: - string - "null" description: This fingerprint represents the backend configuration that the model runs with. usage: type: - object - "null" properties: completion_tokens: type: number description: Number of tokens in the generated completion. prompt_tokens: type: number description: Number of tokens in the prompt. total_tokens: type: number description: Total number of tokens used in the request (prompt + completion). prompt_tokens_details: type: - object - "null" properties: cached_tokens: type: - integer - "null" cache_creation_tokens: type: - integer - "null" audio_tokens: type: - integer - "null" description: The number of audio input tokens consumed by the request. completion_tokens_details: type: - object - "null" properties: reasoning_tokens: type: - number - "null" accepted_prediction_tokens: type: - number - "null" rejected_prediction_tokens: type: - number - "null" audio_tokens: type: - integer - "null" description: The number of audio output tokens produced by the response. description: Usage statistics for the completion request. object: type: string enum: - chat.completion.chunk required: - id - choices - created - model - object description: Represents a streamed chunk of a chat completion response returned by model, based on the provided input. description: "Represents a streamed chunk of a chat completion response returned by model, based on the provided input." x-speakeasy-sse-sentinel: "[DONE]" security: - ApiKey: [] /v2/router/moderations: post: operationId: "createModeration" summary: "Create moderation" tags: - "Moderations" x-speakeasy-group: "router.moderations" x-speakeasy-name-override: "create" x-cli-group: "moderations" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" requestBody: required: true description: "Classifies if text violates content policy" content: application/json: schema: type: "object" properties: input: anyOf: - type: "string" - type: "array" items: type: "string" description: "Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models." model: type: "string" description: "The content moderation model you would like to use. Defaults to omni-moderation-latest" required: - "input" - "model" responses: "200": description: "Returns moderation classification results" content: application/json: schema: type: "object" properties: id: type: "string" description: "The unique identifier for the moderation request" model: type: "string" description: "The model used to generate the moderation results" results: type: "array" items: anyOf: - type: "object" properties: flagged: type: "boolean" description: "Whether any of the categories are flagged" categories: type: "object" properties: hate: type: "boolean" description: "Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste." hate/threatening: type: "boolean" description: "Hateful content that also includes violence or serious harm towards the targeted group." harassment: type: "boolean" description: "Content that expresses, incites, or promotes harassing language towards any target." harassment/threatening: type: "boolean" description: "Harassment content that also includes violence or serious harm towards any target." illicit: type: "boolean" description: "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing." illicit/violent: type: "boolean" description: "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence." self-harm: type: "boolean" description: "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders." self-harm/intent: type: "boolean" description: "Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm." self-harm/instructions: type: "boolean" description: "Content that encourages performing acts of self-harm, or that gives instructions or advice on how to commit such acts." sexual: type: "boolean" description: "Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services." sexual/minors: type: "boolean" description: "Sexual content that includes an individual who is under 18 years old." violence: type: "boolean" description: "Content that depicts death, violence, or physical injury." violence/graphic: type: "boolean" description: "Content that depicts death, violence, or physical injury in graphic detail." required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories, and whether they are flagged or not" category_scores: type: "object" properties: hate: type: "number" description: "The score for the category hate" hate/threatening: type: "number" description: "The score for the category hate/threatening" harassment: type: "number" description: "The score for the category harassment" harassment/threatening: type: "number" description: "The score for the category harassment/threatening" illicit: type: "number" description: "The score for the category illicit" illicit/violent: type: "number" description: "The score for the category illicit/violent" self-harm: type: "number" description: "The score for the category self-harm" self-harm/intent: type: "number" description: "The score for the category self-harm/intent" self-harm/instructions: type: "number" description: "The score for the category self-harm/instructions" sexual: type: "number" description: "The score for the category sexual" sexual/minors: type: "number" description: "The score for the category sexual/minors" violence: type: "number" description: "The score for the category violence" violence/graphic: type: "number" description: "The score for the category violence/graphic" required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories along with their scores as predicted by model" category_applied_input_types: type: "object" properties: hate: type: "array" items: type: "string" description: "The applied input type(s) for the category hate" hate/threatening: type: "array" items: type: "string" description: "The applied input type(s) for the category hate/threatening" harassment: type: "array" items: type: "string" description: "The applied input type(s) for the category harassment" harassment/threatening: type: "array" items: type: "string" description: "The applied input type(s) for the category harassment/threatening" illicit: type: "array" items: type: "string" description: "The applied input type(s) for the category illicit" illicit/violent: type: "array" items: type: "string" description: "The applied input type(s) for the category illicit/violent" self-harm: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm" self-harm/intent: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm/intent" self-harm/instructions: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm/instructions" sexual: type: "array" items: type: "string" description: "The applied input type(s) for the category sexual" sexual/minors: type: "array" items: type: "string" description: "The applied input type(s) for the category sexual/minors" violence: type: "array" items: type: "string" description: "The applied input type(s) for the category violence" violence/graphic: type: "array" items: type: "string" description: "The applied input type(s) for the category violence/graphic" required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories along with the input type(s) that the score applies to" required: - "flagged" - "categories" - "category_scores" - type: "object" properties: categories: type: "object" properties: sexual: type: "boolean" description: "Sexual content detected" hate_and_discrimination: type: "boolean" description: "Hate and discrimination content detected" violence_and_threats: type: "boolean" description: "Violence and threats content detected" dangerous_and_criminal_content: type: "boolean" description: "Dangerous and criminal content detected" selfharm: type: "boolean" description: "Self-harm content detected" health: type: "boolean" description: "Unqualified health advice detected" financial: type: "boolean" description: "Unqualified financial advice detected" law: type: "boolean" description: "Unqualified legal advice detected" pii: type: "boolean" description: "Personally identifiable information detected" required: - "sexual" - "hate_and_discrimination" - "violence_and_threats" - "dangerous_and_criminal_content" - "selfharm" - "health" - "financial" - "law" - "pii" description: "A list of the categories, and whether they are flagged or not" category_scores: type: "object" properties: sexual: type: "number" description: "The score for sexual content" hate_and_discrimination: type: "number" description: "The score for hate and discrimination content" violence_and_threats: type: "number" description: "The score for violence and threats content" dangerous_and_criminal_content: type: "number" description: "The score for dangerous and criminal content" selfharm: type: "number" description: "The score for self-harm content" health: type: "number" description: "The score for unqualified health advice" financial: type: "number" description: "The score for unqualified financial advice" law: type: "number" description: "The score for unqualified legal advice" pii: type: "number" description: "The score for personally identifiable information" required: - "sexual" - "hate_and_discrimination" - "violence_and_threats" - "dangerous_and_criminal_content" - "selfharm" - "health" - "financial" - "law" - "pii" description: "A list of the categories along with their scores as predicted by model" required: - "categories" - "category_scores" description: "A list of moderation objects" required: - "id" - "model" - "results" "422": description: "Returns validation error" content: application/json: schema: type: "object" properties: error: type: "object" properties: message: type: "string" type: type: "string" param: type: - "string" - "null" code: type: "string" required: - "message" - "type" - "param" - "code" required: - "error" security: - ApiKey: [] /v2/router/rerank: post: operationId: "createRerank" summary: "Create rerank" tags: - "Rerank" x-speakeasy-group: "router.rerank" x-speakeasy-name-override: "create" x-cli-group: "rerank" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "Rerank a list of documents based on their relevance to a query." requestBody: required: true description: "input" content: application/json: schema: type: "object" properties: query: type: "string" description: "The search query" documents: type: "array" items: type: "string" description: "A list of texts that will be compared to the `query`. For optimal performance we recommend against sending more than 1,000 documents in a single request." model: type: "string" description: "The identifier of the model to use" top_n: type: "number" description: "The number of most relevant documents or indices to return, defaults to the length of the documents" filename: type: - "string" - "null" description: "The filename of the document to rerank" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "query" - "documents" - "model" responses: "200": description: "Returns the reranked documents." content: application/json: schema: type: "object" properties: id: type: "string" description: "A unique identifier for the rerank." object: type: "string" enum: - "list" results: type: "array" items: type: "object" properties: object: type: "string" enum: - "rerank" description: "The object type, which is always `rerank`." index: type: "number" description: "Corresponds to the index in the original list of documents to which the ranked document belongs." relevance_score: type: "number" description: "Relevance 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." document: type: "object" properties: text: type: "string" description: "The text of the document to rerank" required: - "text" description: "If return_documents is set as false this will return none, if true it will return the documents passed in" required: - "object" - "index" - "relevance_score" description: "An ordered list of ranked documents" usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens used in the rerank" required: - "total_tokens" required: - "object" - "results" security: - ApiKey: [] /v2/router/audio/speech: post: operationId: "createSpeech" summary: "Create speech" tags: - "Audio" x-speakeasy-group: "router.audio.speech" x-speakeasy-name-override: "create" x-cli-group: "speech" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "Generates audio from the input text." requestBody: required: true description: "input" content: application/json: schema: type: "object" properties: input: type: "string" description: "The text to generate audio for. The maximum length is 4096 characters" model: type: "string" description: "ID of the model to use" voice: type: "string" description: "The voice to use. \n\n Available voices for OpenAI \n\n `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` \n\n Available voices for ElevenLabs \n\n `aria`, `roger`, `sarah`, `laura`, `charlie`, `george`, `callum`, `river`, `liam`, `charlotte`, `alice`, `matilda`, `will`, `jessica`, `eric`, `chris`, `brian`, `daniel`, `lily`, `bill`" response_format: type: "string" enum: - "mp3" - "opus" - "aac" - "flac" - "wav" - "pcm" default: "mp3" description: "The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`. If a format is provided but not supported by the provider, the response will be in the default format. When the provided format is not supported by the provider, the response will be in the default format." speed: type: "number" default: 1 description: "The speed of the generated audio." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "input" - "model" - "voice" responses: "200": description: "The audio file content." security: - ApiKey: [] /v2/router/completions: post: operationId: "createCompletion" summary: "Create completion" tags: - "Completions" x-speakeasy-group: "router.completions" x-speakeasy-name-override: "create" x-cli-group: "completions" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "For sending requests to legacy completion models" requestBody: required: true content: application/json: schema: allOf: - type: "object" properties: model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays." echo: type: - "boolean" - "null" default: false description: "Echo back the prompt in addition to the completion" frequency_penalty: type: - "number" - "null" default: 0 description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "number" - "null" default: 16 description: "The maximum number of tokens that can be generated in the completion." presence_penalty: type: - "number" - "null" minimum: -2 maximum: 2 default: 0 description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" - type: "null" default: null description: "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence." temperature: type: - "number" - "null" default: 1 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" default: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered." n: type: - "number" - "null" default: 1 description: "How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota." user: type: "string" description: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" - type: "null" description: "Configuration for the thinking mode capability. Set type to `adaptive` for models that support adaptive thinking (e.g. Claude Opus 4.6, Sonnet 4.6), or `enabled` with `budget_tokens` for manual control." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" inputs: anyOf: - type: "object" additionalProperties: {} - type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" required: - "key" deprecated: true description: "@deprecated Use top-level `variables` field instead. Values to replace in the prompt messages using {{variableName}} syntax." example: customer_name: "John Smith" product_name: "Premium Plan" issue_type: "billing" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." knowledge_bases: type: "array" items: type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" query: type: "string" description: "The query to use to search the knowledge base. If not provided we will use the last user message from the messages of the requests" required: - "knowledge_id" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." description: "Leverage Orq's intelligent routing capabilities to enhance your AI application with enterprise-grade reliability and observability. Orq provides automatic request management including retries on failures, model fallbacks for high availability, identity-level analytics tracking, conversation threading, and dynamic prompt templating with variable substitution." deprecated: true example: retry: count: 3 on_codes: - 429 - 500 - 502 fallbacks: - model: "openai/gpt-5" - model: "anthropic/claude-4-opus" identity: id: "identity_01ARZ3NDEKTSV4RRFFQ69G5FAV" display_name: "Jane Doe" email: "jane.doe@example.com" thread: id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: - "customer-support" inputs: customer_name: "John Smith" issue_type: "billing" cache: ttl: 3600 type: "exact_match" knowledge_bases: - knowledge_id: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV" top_k: 5 timeout: call_timeout: 30000 security: mask: - "input" - "system" required: - "model" - "prompt" - type: "object" properties: stream: type: "boolean" default: false responses: "200": description: "Represents a completion response from the API." content: application/json: schema: type: "object" properties: id: type: "string" description: "A unique identifier for the completion." choices: type: "array" items: type: "object" properties: finish_reason: type: "string" enum: - "stop" - "length" - "content_filter" - "tool_calls" description: "The reason the model stopped generating tokens." index: type: "number" description: "The index of the choice in the list of choices." text: type: "string" required: - "finish_reason" - "index" - "text" description: "The list of completion choices the model generated for the input prompt." created: anyOf: - type: "string" - type: "number" description: "The Unix timestamp (in seconds) of when the chat completion was created." model: type: "string" description: "The model used for the chat completion." system_fingerprint: type: "string" description: "This fingerprint represents the backend configuration that the model runs with." object: type: "string" description: "The object type" usage: type: "object" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Usage statistics for the completion request." required: - "id" - "choices" - "model" - "object" text/event-stream: schema: type: "object" properties: data: type: object properties: id: type: string description: A unique identifier for the completion. choices: type: array items: type: object properties: finish_reason: type: string enum: - stop - length - content_filter - tool_calls description: The reason the model stopped generating tokens. index: type: number description: The index of the choice in the list of choices. text: type: string required: - finish_reason - index - text description: The list of completion choices the model generated for the input prompt. created: anyOf: - type: string - type: number description: The Unix timestamp (in seconds) of when the chat completion was created. model: type: string description: The model used for the chat completion. system_fingerprint: type: string description: This fingerprint represents the backend configuration that the model runs with. object: type: string description: The object type usage: type: object properties: completion_tokens: type: number description: Number of tokens in the generated completion. prompt_tokens: type: number description: Number of tokens in the prompt. total_tokens: type: number description: Total number of tokens used in the request (prompt + completion). prompt_tokens_details: type: - object - "null" properties: cached_tokens: type: - integer - "null" cache_creation_tokens: type: - integer - "null" audio_tokens: type: - integer - "null" description: The number of audio input tokens consumed by the request. completion_tokens_details: type: - object - "null" properties: reasoning_tokens: type: - number - "null" accepted_prediction_tokens: type: - number - "null" rejected_prediction_tokens: type: - number - "null" audio_tokens: type: - integer - "null" description: The number of audio output tokens produced by the response. description: Usage statistics for the completion request. required: - id - choices - model - object x-speakeasy-sse-sentinel: "[DONE]" security: - ApiKey: [] /v2/router/images/generations: post: operationId: "createImage" summary: "Create image" tags: - "Images" x-speakeasy-group: "router.images.generations" x-speakeasy-name-override: "create" x-cli-group: "images" x-cli-name: "generate" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "Create an Image" requestBody: required: true description: "input" content: application/json: schema: type: "object" properties: prompt: type: "string" description: "A text description of the desired image(s)." background: type: - "string" - "null" enum: - "transparent" - "opaque" - "auto" - null description: "Allows to set transparency for the background of the generated image(s). This parameter is only supported for `openai/gpt-image-1`." model: type: "string" description: "The model to use for image generation. One of `openai/dall-e-2`, `openai/dall-e-3`, or `openai/gpt-image-1`." moderation: type: - "string" - "null" enum: - "low" - "auto" - null description: "Control the content-moderation level for images generated by `gpt-image-1`. Must be either `low` or `auto`." n: type: - "integer" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported." output_compression: type: - "integer" - "null" minimum: 0 maximum: 100 description: "The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats." output_format: type: - "string" - "null" enum: - "png" - "jpeg" - "webp" - null description: "The format in which the generated images are returned. This parameter is only supported for `openai/gpt-image-1`." quality: type: - "string" - "null" enum: - "auto" - "high" - "medium" - "low" - "hd" - "standard" - null description: "The quality of the image that will be generated. `auto` will automatically select the best quality for the given model." response_format: type: - "string" - "null" enum: - "url" - "b64_json" - null description: "The format in which generated images are returned. Must be one of `url` or `b64_json`. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images." size: type: - "string" - "null" description: "The size of the generated images. Must be one of the specified sizes for each model." style: type: - "string" - "null" enum: - "vivid" - "natural" - null description: "The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`." metadata: type: "object" additionalProperties: type: "string" maxLength: 512 description: "Optional metadata for the request. This metadata will be stored in the trace and can be used for filtering." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "prompt" - "model" responses: "200": description: "Represents an image generation response from the API." content: application/json: schema: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." data: type: "array" items: type: "object" properties: revised_prompt: type: - "string" - "null" description: "The prompt that was used to generate the image, if there was any revision to the prompt." b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if `response_format` is `b64_json`" url: type: "string" description: "The url of the generated image, if `response_format` is `url` (default)" description: "Represents the url or the content of an image generated." usage: type: "object" properties: input_tokens: type: "number" input_tokens_details: type: "object" properties: image_tokens: type: "number" text_tokens: type: "number" output_tokens: type: "number" total_tokens: type: "number" required: - "input_tokens_details" required: - "created" - "data" security: - ApiKey: [] /v2/router/images/edits: post: operationId: "createImageEdit" summary: "Create image edit" tags: - "Images" x-speakeasy-group: "router.images.edits" x-speakeasy-name-override: "create" x-cli-group: "images" x-cli-name: "edit" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "Edit an Image" requestBody: required: true content: multipart/form-data: schema: type: "object" properties: model: type: "string" description: "The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway-supported-models#image-models)" image: description: "The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images." prompt: type: "string" description: "A text description of the desired image(s)." n: type: - "number" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10." size: type: - "string" - "null" description: "The size of the generated images" quality: type: - "string" - "null" enum: - "auto" - "high" - "medium" - "low" - "standard" - null description: "The quality of the image that will be generated. Auto will automatically select the best quality for the given model." response_format: type: "string" enum: - "url" - "b64_json" description: "The format in which the generated images are returned. Some of the models only return the image in base64 format." user: type: "string" description: "A unique identifier representing your end-user, which can help to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "model" - "prompt" responses: "200": description: "Represents an image edit response from the API." content: application/json: schema: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." output_format: type: "string" description: "The output format of the image generation" size: type: "string" description: "The size of the image generated" quality: type: "string" description: "The quality of the image generated" data: type: "array" items: type: "object" properties: b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if response_format is b64_json" url: type: "string" description: "The URL of the generated image, if response_format is url (default)" description: "The list of generated images." usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens (images and text) used for the image generation." input_tokens: type: "number" description: "The number of tokens (images and text) in the input prompt." output_tokens: type: "number" description: "The number of output tokens generated by the model." input_tokens_details: type: "object" properties: text_tokens: type: "number" description: "The number of text tokens in the input prompt." image_tokens: type: "number" description: "The number of image tokens in the input prompt." required: - "text_tokens" - "image_tokens" description: "The input tokens detailed information for the image generation." required: - "total_tokens" - "input_tokens" - "output_tokens" - "input_tokens_details" description: "The token usage information for the image generation." required: - "created" - "data" security: - ApiKey: [] /v2/router/images/variations: post: operationId: "createImageVariation" summary: "Create image variation" tags: - "Images" x-speakeasy-group: "router.images.variations" x-speakeasy-name-override: "create" x-cli-group: "images" x-cli-name: "variation" x-speakeasy-ignore: false x-orq-gateway-group: "true" description: "Create an Image Variation" requestBody: required: true description: "input" content: multipart/form-data: schema: type: "object" properties: image: description: "The image to edit. Must be a supported image file. It should be a png, webp, or jpg file less than 50MB." model: type: "string" description: "The model to use for image generation." n: type: - "number" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10." response_format: type: "string" enum: - "url" - "b64_json" default: "url" description: "The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated." size: type: "string" enum: - "256x256" - "512x512" - "1024x1024" default: "1024x1024" description: "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`." user: type: "string" description: "A unique identifier representing your end-user, which can help to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "model" responses: "200": description: "Represents an image variation response from the API." content: application/json: schema: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." output_format: type: "string" description: "The output format of the image generation" size: type: "string" description: "The size of the image generated" quality: type: "string" description: "The quality of the image generated" data: type: "array" items: type: "object" properties: b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if response_format is b64_json" url: type: "string" description: "The URL of the generated image, if response_format is url (default)" description: "The list of generated images." usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens (images and text) used for the image generation." input_tokens: type: "number" description: "The number of tokens (images and text) in the input prompt." output_tokens: type: "number" description: "The number of output tokens generated by the model." input_tokens_details: type: "object" properties: text_tokens: type: "number" description: "The number of text tokens in the input prompt." image_tokens: type: "number" description: "The number of image tokens in the input prompt." required: - "text_tokens" - "image_tokens" description: "The input tokens detailed information for the image generation." required: - "total_tokens" - "input_tokens" - "output_tokens" - "input_tokens_details" description: "The token usage information for the image generation." required: - "created" - "data" security: - ApiKey: [] /v2/router/audio/transcriptions: post: operationId: "createTranscription" summary: "Create transcription" tags: - "Audio" x-speakeasy-group: "router.audio.transcriptions" x-speakeasy-name-override: "create" x-cli-group: "transcriptions" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" requestBody: required: true description: "Transcribes audio into the input language." content: multipart/form-data: schema: type: "object" properties: model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." enable_logging: type: "boolean" default: true description: "When enable_logging is set to false, zero retention mode is used. This disables history features like request stitching and is only available to enterprise customers." diarize: type: "boolean" default: false description: "Whether to annotate which speaker is currently talking in the uploaded file." response_format: type: "string" enum: - "json" - "text" - "srt" - "verbose_json" - "vtt" description: "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt." tag_audio_events: type: "boolean" default: true description: "Whether to tag audio events like (laughter), (footsteps), etc. in the transcription." num_speakers: type: "number" description: "The maximum amount of speakers talking in the uploaded file. Helps with predicting who speaks when, the maximum is 32. " timestamps_granularity: type: "string" enum: - "none" - "word" - "character" default: "word" description: "The granularity of the timestamps in the transcription. Word provides word-level timestamps and character provides character-level timestamps per word." temperature: type: "number" example: 0.5 description: "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." language: type: "string" description: "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." timestamp_granularities: type: "array" items: type: "string" enum: - "word" - "segment" description: "The timestamp granularities to populate for this transcription. response_format must be set to verbose_json to use timestamp granularities. Either or both of these options are supported: \"word\" or \"segment\". Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency." example: - "word" - "segment" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." file: type: "string" description: "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm." format: "binary" required: - "model" responses: "200": description: "Returns the transcription or verbose transcription" content: application/json: schema: anyOf: - type: "object" properties: text: type: "string" required: - "text" - type: "object" properties: task: type: "string" language: type: "string" duration: type: "number" text: type: "string" words: type: "array" items: type: "object" properties: word: type: "string" start: type: "number" end: type: "number" segments: type: "array" items: type: "object" properties: id: type: "number" seek: type: "number" start: type: "number" end: type: "number" text: type: "string" tokens: type: "array" items: type: "number" temperature: type: "number" avg_logprob: type: "number" compression_ratio: type: "number" no_speech_prob: type: "number" required: - "id" - "seek" - "start" - "end" - "text" - "tokens" - "temperature" - "avg_logprob" - "compression_ratio" - "no_speech_prob" required: - "text" - type: "string" "422": description: "Returns validation error" content: application/json: schema: type: "object" properties: error: type: "object" properties: message: type: "string" type: type: "string" param: type: - "string" - "null" code: type: "string" required: - "message" - "type" - "param" - "code" required: - "error" security: - ApiKey: [] /v2/router/audio/translations: post: operationId: "createTranslation" summary: "Create translation" tags: - "Audio" x-speakeasy-group: "router.audio.translations" x-speakeasy-name-override: "create" x-cli-group: "translations" x-cli-name: "create" x-speakeasy-ignore: false x-orq-gateway-group: "true" requestBody: required: true description: "Translates audio into English." content: multipart/form-data: schema: type: "object" properties: model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." enable_logging: type: "boolean" default: true description: "When enable_logging is set to false, zero retention mode is used. This disables history features like request stitching and is only available to enterprise customers." diarize: type: "boolean" default: false description: "Whether to annotate which speaker is currently talking in the uploaded file." response_format: type: "string" enum: - "json" - "text" - "srt" - "verbose_json" - "vtt" description: "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt." tag_audio_events: type: "boolean" default: true description: "Whether to tag audio events like (laughter), (footsteps), etc. in the transcription." num_speakers: type: "number" description: "The maximum amount of speakers talking in the uploaded file. Helps with predicting who speaks when, the maximum is 32. " timestamps_granularity: type: "string" enum: - "none" - "word" - "character" default: "word" description: "The granularity of the timestamps in the transcription. Word provides word-level timestamps and character provides character-level timestamps per word." temperature: type: "number" example: 0.5 description: "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." file: type: "string" description: "The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm." format: "binary" required: - "model" responses: "200": description: "Returns the translated text" content: application/json: schema: anyOf: - type: "object" properties: text: type: "string" required: - "text" - type: "object" properties: task: type: "string" language: type: "string" duration: type: "number" text: type: "string" words: type: "array" items: type: "object" properties: word: type: "string" start: type: "number" end: type: "number" segments: type: "array" items: type: "object" properties: id: type: "number" seek: type: "number" start: type: "number" end: type: "number" text: type: "string" tokens: type: "array" items: type: "number" temperature: type: "number" avg_logprob: type: "number" compression_ratio: type: "number" no_speech_prob: type: "number" required: - "id" - "seek" - "start" - "end" - "text" - "tokens" - "temperature" - "avg_logprob" - "compression_ratio" - "no_speech_prob" required: - "text" - type: "string" "422": description: "Returns validation error" content: application/json: schema: type: "object" properties: error: type: "object" properties: message: type: "string" type: type: "string" param: type: - "string" - "null" code: type: "string" required: - "message" - "type" - "param" - "code" required: - "error" security: - ApiKey: [] /v2/router/ocr: post: tags: - "Router" x-speakeasy-group: "router" x-speakeasy-name-override: "ocr" x-cli-group: "ocr" x-cli-name: "ocr" description: "Extracts text content while maintaining document structure and hierarchy" requestBody: required: true description: "input" content: application/json: schema: type: "object" properties: model: type: "string" description: "ID of the model to use for OCR." document: anyOf: - type: "object" properties: type: type: "string" enum: - "document_url" document_url: type: "string" format: "uri" description: "URL of the document to process" document_name: type: "string" description: "The name of the document" required: - "type" - "document_url" - type: "object" properties: type: type: "string" enum: - "image_url" image_url: anyOf: - type: "string" description: "Base64 encoded image" - type: "object" properties: url: type: "string" format: "uri" detail: type: "string" required: - "url" description: "URL of the image to process" required: - "type" - "image_url" description: "Document to run OCR on. Can be a DocumentURLChunk or ImageURLChunk." pages: type: - "array" - "null" items: type: "integer" description: "Specific pages to process. Can be a single number, range, or list. Starts from 0. Null for all pages." ocr_settings: type: "object" properties: include_image_base64: type: - "boolean" - "null" description: "Whether to include image Base64 in the response. Null for default." max_images_to_include: type: "integer" description: "Maximum number of images to extract. Null for no limit." image_min_size: type: "integer" description: "Minimum height and width of image to extract. Null for no minimum." description: "Optional settings for the OCR run" required: - "model" - "document" responses: "200": description: "Represents an OCR response from the API." content: application/json: schema: type: "object" properties: model: type: "string" description: "ID of the model used for OCR." pages: type: "array" items: type: "object" properties: index: type: "number" description: "The page index in a pdf document starting from 0" markdown: type: "string" description: "The markdown string response of the page" images: type: "array" items: type: "object" properties: id: type: "string" description: "The id of the image" image_base64: type: - "string" - "null" description: "The base64 encoded image" required: - "id" dimensions: type: - "object" - "null" properties: dpi: type: "integer" description: "Dots per inch of the page-image" height: type: "integer" description: "Height of the image in pixels" width: type: "integer" description: "Width of the image in pixels" required: - "dpi" - "height" - "width" description: "The dimensions of the PDF Page's screenshot image" required: - "index" - "markdown" - "images" usage: oneOf: - type: "object" properties: type: type: "string" enum: - "pages" pages_processed: type: "integer" description: "The number of pages processed" required: - "type" - "pages_processed" description: "The usage information for the OCR run counted as pages processed" - type: "object" properties: type: type: "string" enum: - "tokens" tokens_processed: type: "integer" description: "The number of tokens processed" required: - "type" - "tokens_processed" description: "The usage information for the OCR run counted as tokens processed" required: - "model" - "pages" - "usage" security: - ApiKey: [] /v2/traces/{trace_id}/spans/{span_id}/annotation: post: tags: - "Annotations" x-speakeasy-group: "annotations" x-speakeasy-name-override: "create" x-cli-group: "traces" x-cli-name: "create" operationId: "CreateAnnotation" summary: "Annotate a span" description: "Attach one or more annotations to a specific span. A standard annotation references a human review by key and supplies a value. A correction references an existing evaluator output by parent_annotation_id and supplies the corrected value, validated against that evaluator's output schema." parameters: - schema: type: "string" description: "Unique identifier of the trace" required: true description: "Unique identifier of the trace" name: "trace_id" in: "path" - schema: type: "string" description: "Unique identifier of the span" required: true description: "Unique identifier of the span" name: "span_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: annotations: type: "array" items: anyOf: - type: "object" properties: key: type: "string" description: "Unique key of the review." value: anyOf: - type: "string" minLength: 0 maxLength: 3000 - type: "number" - type: "boolean" - type: "array" items: type: "string" minItems: 1 description: "The feedback value. For single-select, provide a string or single-element array. For multi-select, provide an array of strings. For range evaluations, provide a number. For boolean, provide a boolean. For text/correction, provide a string." required: - "key" - "value" additionalProperties: false - type: "object" properties: parent_annotation_id: type: "string" description: "The eval id of the evaluator annotation being corrected." value: anyOf: - type: "string" minLength: 0 maxLength: 3000 - type: "number" - type: "boolean" - type: "array" items: type: "string" minItems: 1 description: "The feedback value. For single-select, provide a string or single-element array. For multi-select, provide an array of strings. For range evaluations, provide a number. For boolean, provide a boolean. For text/correction, provide a string." explanation: type: "string" maxLength: 3000 description: "Optional explanation for the correction." required: - "parent_annotation_id" - "value" additionalProperties: false minItems: 1 maxItems: 10 metadata: type: "object" properties: identity_id: type: "string" required: - "annotations" responses: "200": description: "Span annotated" security: - ApiKey: [] delete: tags: - "Annotations" x-speakeasy-group: "annotations" x-speakeasy-name-override: "delete" x-cli-group: "traces" x-cli-name: "delete" operationId: "DeleteAnnotation" summary: "Remove an annotation from a span" description: "Remove one or more annotations from a specific span by their evaluator keys, or remove corrections by the eval ids of their parent annotations." parameters: - schema: type: "string" description: "Unique identifier of the trace" required: true description: "Unique identifier of the trace" name: "trace_id" in: "path" - schema: type: "string" description: "Unique identifier of the span" required: true description: "Unique identifier of the span" name: "span_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: keys: type: "array" items: type: "string" maxItems: 10 description: "Unique keys of the reviews to remove" parent_annotation_ids: type: "array" items: type: "string" maxItems: 10 description: "Eval ids whose corrections should be removed" metadata: type: "object" properties: identity_id: type: "string" responses: "200": description: "Annotation removed" security: - ApiKey: [] /v2/feedback/evaluation/remove: post: tags: - "Feedback" x-speakeasy-name-override: "removeEvaluation" requestBody: content: application/json: schema: type: "object" properties: id: type: "string" format: "ulid" trace_id: type: "string" required: - "id" - "trace_id" responses: "200": description: "Event has been dispatched to delete the evaluation" security: - ApiKey: [] /v2/feedback/evaluation: post: tags: - "Feedback" x-speakeasy-name-override: "createEvaluation" requestBody: content: application/json: schema: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.031Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" trace_id: type: "string" required: - "id" - "evaluation_type" - "type" - "value" - "trace_id" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.032Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" trace_id: type: "string" required: - "id" - "evaluation_type" - "type" - "value" - "trace_id" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.032Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" trace_id: type: "string" required: - "id" - "evaluation_type" - "type" - "value" - "trace_id" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.033Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" trace_id: type: "string" required: - "id" - "evaluation_type" - "type" - "values" - "trace_id" responses: "200": description: "Event has been dispatched to report the feedback" security: - ApiKey: [] /v2/feedback/remove: post: tags: - "Feedback" x-cli-group: "feedback" x-cli-name: "delete" x-speakeasy-name-override: "remove" requestBody: content: application/json: schema: type: "object" properties: id: type: "string" format: "ulid" trace_id: type: "string" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" required: - "id" - "trace_id" - "product" responses: "200": description: "Event has been dispatched to delete the feedback" content: application/json: schema: type: "object" properties: id: type: "string" format: "ulid" trace_id: type: "string" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" required: - "id" - "trace_id" - "product" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/feedback: post: tags: - "Feedback" x-cli-group: "feedback" x-cli-name: "create" x-speakeasy-name-override: "create" requestBody: content: application/json: schema: type: "object" properties: id: type: "string" format: "ulid" description: "Unique identifier for the feedback" property: type: "string" description: "A string describing the specific property or aspect rated." x-speakeasy-name-override: field value: anyOf: - type: "string" - type: "number" - type: "array" items: type: "string" description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." trace_id: type: "string" description: "The id returned by the [`get_config`](https://docs.orq.ai/reference/deployments/get-config) or [`invoke`](https://docs.orq.ai/reference/deployments/invoke) endpoints" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" default: "deployments" required: - "property" - "value" - "trace_id" responses: "200": description: "Event has been dispatched to delete the feedback" content: application/json: schema: type: "object" properties: id: type: "string" format: "ulid" description: "Unique identifier for the feedback" property: type: "string" description: "A string describing the specific property or aspect rated." value: anyOf: - type: "string" - type: "number" - type: "array" items: type: "string" description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string." trace_id: type: "string" description: "The id returned by the [`get_config`](https://docs.orq.ai/reference/deployments/get-config) or [`invoke`](https://docs.orq.ai/reference/deployments/invoke) endpoints" product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" default: "deployments" required: - "property" - "value" - "trace_id" "400": description: "Bad Request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" "404": description: "Workspace ID is not found on the request" content: application/json: schema: type: "object" properties: message: type: "string" required: - "message" security: - ApiKey: [] /v2/human-eval-sets: get: tags: - "Human Review Sets" x-cli-group: "human-review-sets" x-cli-name: "getAll" x-cli-hidden: true x-speakeasy-name-override: "list" summary: "Get all human review sets" parameters: - schema: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to filter human review sets by project" required: false description: "Optional project ID to filter human review sets by project" name: "project_id" in: "query" responses: "200": description: "Successfully retrieved all human review sets" content: application/json: schema: type: "array" items: oneOf: - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_values" - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_value" security: - ApiKey: [] post: tags: - "Human Review Sets" x-cli-group: "human-review-sets" x-cli-name: "create" x-cli-hidden: true x-speakeasy-name-override: "create" summary: "Create a human review set" requestBody: content: application/json: schema: oneOf: - type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "display_name" - "human_eval_ids" - "filter_type" - "filter_values" - type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "display_name" - "human_eval_ids" - "filter_type" - "filter_value" responses: "200": description: "Successfully created a human review set" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_values" - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_value" security: - ApiKey: [] /v2/human-eval-sets/{id}: get: tags: - "Human Review Sets" x-cli-group: "human-review-sets" x-cli-name: "get" x-cli-hidden: true x-speakeasy-name-override: "get" summary: "Get a human review set by ID" parameters: - schema: type: "string" description: "The ID of the human review set to retrieve" required: true description: "The ID of the human review set to retrieve" name: "id" in: "path" responses: "200": description: "Successfully retrieved the human review set" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_values" - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_value" security: - ApiKey: [] patch: tags: - "Human Review Sets" x-cli-group: "human-review-sets" x-cli-name: "update" x-cli-hidden: true x-speakeasy-name-override: "update" summary: "Update a human review set" parameters: - schema: type: "string" description: "The ID of the human review set to retrieve" required: true description: "The ID of the human review set to retrieve" name: "id" in: "path" requestBody: content: application/json: schema: oneOf: - type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "display_name" - "human_eval_ids" - "filter_type" - "filter_values" - type: "object" properties: display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "display_name" - "human_eval_ids" - "filter_type" - "filter_value" responses: "200": description: "Successfully updated the human review set" content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "span_type" filter_values: type: "array" items: type: "string" minItems: 1 description: "Array of span types to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_values" - type: "object" properties: _id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" display_name: type: "string" minLength: 1 maxLength: 255 description: "Display name of the human review set" description: type: "string" description: "Detailed description of the human review set" human_eval_ids: type: "array" items: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" minItems: 1 description: "Array of human review IDs to be applied to matching spans" workspace_id: type: "string" project_id: anyOf: - type: "string" - type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" description: "Optional project ID to scope this human review set to a specific project" created_by_id: type: "string" updated_by_id: type: "string" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" filter_type: type: "string" enum: - "name" filter_value: type: "string" minLength: 1 description: "Name pattern to match" required: - "_id" - "display_name" - "human_eval_ids" - "workspace_id" - "filter_type" - "filter_value" security: - ApiKey: [] delete: tags: - "Human Review Sets" x-cli-group: "human-review-sets" x-cli-name: "delete" x-cli-hidden: true x-speakeasy-name-override: "delete" summary: "Delete a human review set" parameters: - schema: type: "string" description: "The ID of the human review set to retrieve" required: true description: "The ID of the human review set to retrieve" name: "id" in: "path" responses: "200": description: "Successfully deleted the human review set" security: - ApiKey: [] /v2/annotation-queues: get: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "list" operationId: "ListAnnotationQueues" x-cli-group: "annotation-queues" x-cli-name: "list" summary: "List annotation queues" description: "Retrieves a paginated list of annotation queues for the current workspace. Results can be paginated using cursor-based pagination." parameters: - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" - schema: type: "string" description: "Filter annotation queues by display name (case-insensitive match)." required: false description: "Filter annotation queues by display name (case-insensitive match)." name: "search" in: "query" - schema: type: "string" description: "Comma-separated list of user IDs; returns annotation queues last updated by any of them." required: false description: "Comma-separated list of user IDs; returns annotation queues last updated by any of them." name: "updated_by" in: "query" responses: "200": description: "Annotation queues Retrieved Successfully" content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: _id: type: "string" description: "The unique identifier of the annotation queue" display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" project_id: type: "string" description: "The project ID. When set, human reviews are resolved from the project automatically" human_review_ids: type: "array" items: type: "string" description: "Legacy: manually selected human review IDs. Used only when project_id is not set" metadata: type: "object" properties: items_count: type: "number" description: "The number of items in the annotation queue" required: - "items_count" created_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who created the resource" updated_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who last updated the resource" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "description" - "workspace_id" - "human_review_ids" - "metadata" has_more: type: "boolean" required: - "object" - "data" - "has_more" x-code-samples: - lang: "curl" label: "Core - List annotation queues" source: "curl --get 'https://api.orq.ai/v2/annotation-queues' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=50' \\\n --data-urlencode 'search=support'\n" - lang: "python" label: "Python - List annotation queues" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.annotation_queues.list(\n limit=50,\n search=\"support\",\n)\n\nfor queue in page.data:\n print(queue.id, queue.display_name)\n" - lang: "typescript" label: "Node.js - List annotation queues" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst page = await client.annotationQueues.list({\n limit: 50,\n search: 'support',\n});\n\nfor (const queue of page.data) {\n console.log(queue.id, queue.displayName);\n}\n" security: - ApiKey: [] post: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "create" operationId: "CreateAnnotationQueue" x-cli-group: "annotation-queues" x-cli-name: "create" summary: "Create an annotation queue" requestBody: content: application/json: schema: type: "object" properties: display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" project_id: type: "string" description: "The project ID to link this annotation queue to" required: - "display_name" - "description" - "project_id" responses: "200": description: "Annotation queue created" content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the annotation queue" display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" project_id: type: "string" description: "The project ID. When set, human reviews are resolved from the project automatically" human_review_ids: type: "array" items: type: "string" description: "Legacy: manually selected human review IDs. Used only when project_id is not set" metadata: type: "object" properties: items_count: type: "number" description: "The number of items in the annotation queue" required: - "items_count" created_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who created the resource" updated_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who last updated the resource" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "description" - "workspace_id" - "human_review_ids" - "metadata" x-code-samples: - lang: "curl" label: "Core - Create an annotation queue" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/annotation-queues' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"project_id\": \"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n \"display_name\": \"Support quality review\",\n \"description\": \"Human review of support agent responses\"\n }'\n" - lang: "python" label: "Python - Create an annotation queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nqueue = client.annotation_queues.create(\n project_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n display_name=\"Support quality review\",\n description=\"Human review of support agent responses\",\n)\n\nprint(queue.id)\n" - lang: "typescript" label: "Node.js - Create an annotation queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst queue = await client.annotationQueues.create({\n projectId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n displayName: 'Support quality review',\n description: 'Human review of support agent responses',\n});\n\nconsole.log(queue.id);\n" security: - ApiKey: [] /v2/annotation-queues/{annotation_queue_id}: get: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "retrieve" operationId: "RetrieveAnnotationQueue" x-cli-group: "annotation-queues" x-cli-name: "get" summary: "Retrieve an annotation queue" description: "Retrieves a specific annotation queue by its unique identifier" parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" responses: "200": description: "Annotation queue retrieved successfully. Returns the complete annotation queue object." content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the annotation queue" display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" project_id: type: "string" description: "The project ID. When set, human reviews are resolved from the project automatically" human_review_ids: type: "array" items: type: "string" description: "Legacy: manually selected human review IDs. Used only when project_id is not set" metadata: type: "object" properties: items_count: type: "number" description: "The number of items in the annotation queue" required: - "items_count" created_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who created the resource" updated_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who last updated the resource" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "description" - "workspace_id" - "human_review_ids" - "metadata" x-code-samples: - lang: "curl" label: "Core - Retrieve an annotation queue" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve an annotation queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nqueue = client.annotation_queues.retrieve(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n)\n\nprint(queue.display_name, queue.metadata.items_count)\n" - lang: "typescript" label: "Node.js - Retrieve an annotation queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst queue = await client.annotationQueues.retrieve({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n});\n\nconsole.log(queue.displayName, queue.metadata.itemsCount);\n" security: - ApiKey: [] patch: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "update" operationId: "UpdateAnnotationQueue" x-cli-group: "annotation-queues" x-cli-name: "update" summary: "Edit an annotation queue" parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" project_id: type: "string" description: "The project ID. When set, human reviews are resolved from the project automatically" human_review_ids: type: "array" items: type: "string" description: "Legacy: update manually selected human review IDs. Only allowed when project_id is not set" responses: "200": description: "Annotation queue updated" content: application/json: schema: type: "object" properties: _id: type: "string" description: "The unique identifier of the annotation queue" display_name: type: "string" description: "The display name of the annotation queue" description: type: "string" description: "The description of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" project_id: type: "string" description: "The project ID. When set, human reviews are resolved from the project automatically" human_review_ids: type: "array" items: type: "string" description: "Legacy: manually selected human review IDs. Used only when project_id is not set" metadata: type: "object" properties: items_count: type: "number" description: "The number of items in the annotation queue" required: - "items_count" created_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who created the resource" updated_by_id: type: - "string" - "null" format: "uuid" description: "The id of the user who last updated the resource" created: anyOf: - type: "string" format: "date-time" - type: "string" format: "date-time" default: "2026-08-07T14:35:51.596Z" readOnly: true format: "date-time" description: "The date and time the resource was created" updated: anyOf: - type: "string" format: "date-time" default: "2026-08-07T14:35:51.597Z" - type: "string" format: "date-time" readOnly: true format: "date-time" description: "The date and time the resource was last updated" required: - "_id" - "display_name" - "description" - "workspace_id" - "human_review_ids" - "metadata" x-code-samples: - lang: "curl" label: "Core - Update an annotation queue" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"display_name\": \"Support quality review (Q3)\",\n \"description\": \"Updated review scope\"\n }'\n" - lang: "python" label: "Python - Update an annotation queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nqueue = client.annotation_queues.update(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n display_name=\"Support quality review (Q3)\",\n description=\"Updated review scope\",\n)\n\nprint(queue.updated)\n" - lang: "typescript" label: "Node.js - Update an annotation queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst queue = await client.annotationQueues.update({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n displayName: 'Support quality review (Q3)',\n description: 'Updated review scope',\n});\n\nconsole.log(queue.updated);\n" security: - ApiKey: [] delete: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "delete" operationId: "DeleteAnnotationQueue" x-cli-group: "annotation-queues" x-cli-name: "delete" summary: "Delete an annotation queue" parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" responses: "204": description: "No content - Annotation queue successfully deleted" "404": description: "Annotation queue not found" x-code-samples: - lang: "curl" label: "Core - Delete an annotation queue" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete an annotation queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.annotation_queues.delete(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n)\n" - lang: "typescript" label: "Node.js - Delete an annotation queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nawait client.annotationQueues.delete({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n});\n" security: - ApiKey: [] /v2/annotation-queues/{annotation_queue_id}/clear: delete: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "clear" operationId: "ClearAnnotationQueue" x-cli-group: "annotation-queues" x-cli-name: "clear" description: "Delete all items from an annotation queue. This action is irreversible." summary: "Delete all items" parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" responses: "204": description: "No content - successful operation" x-code-samples: - lang: "curl" label: "Core - Remove all items from a queue" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX/clear' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Remove all items from a queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.annotation_queues.clear(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n)\n" - lang: "typescript" label: "Node.js - Remove all items from a queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nawait client.annotationQueues.clear({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n});\n" security: - ApiKey: [] /v2/annotation-queues/{annotation_queue_id}/items: get: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "listItems" operationId: "ListAnnotationQueueItems" x-cli-group: "annotation-queues" x-cli-name: "queryItems" summary: "Query items from an annotation queue" description: "Queries items from the specified annotation queue." parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" - schema: type: "integer" minimum: 1 maximum: 200 default: 10 description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" required: false description: "A limit on the number of objects to be returned. Limit can range between 1 and 200, and the default is 10" name: "limit" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "starting_after" in: "query" - schema: type: "string" description: "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." required: false description: "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." name: "ending_before" in: "query" responses: "200": description: "Annotation queue items retrieved." content: application/json: schema: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: oneOf: - type: "object" properties: _id: type: "string" annotation_queue_id: type: "string" description: "The unique identifier of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" used_human_review_ids: type: "array" items: type: "string" description: "The unique identifiers of the human reviews that have been used to annotate the item" span_id: type: "string" trace_id: type: "string" description: "The trace identifier this span belongs to" type: type: "string" enum: - "span" required: - "_id" - "annotation_queue_id" - "workspace_id" - "span_id" - "type" - type: "object" properties: _id: type: "string" annotation_queue_id: type: "string" description: "The unique identifier of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" used_human_review_ids: type: "array" items: type: "string" description: "The unique identifiers of the human reviews that have been used to annotate the item" datapoint_id: type: "string" type: type: "string" enum: - "datapoint" required: - "_id" - "annotation_queue_id" - "workspace_id" - "datapoint_id" - "type" has_more: type: "boolean" required: - "object" - "data" - "has_more" x-code-samples: - lang: "curl" label: "Core - List items in a queue" source: "curl --get 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX/items' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25'\n" - lang: "python" label: "Python - List items in a queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.annotation_queues.list_items(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n limit=25,\n)\n\nfor item in page.data:\n print(item.id, item.type)\n" - lang: "typescript" label: "Node.js - List items in a queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst page = await client.annotationQueues.listItems({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n limit: 25,\n});\n\nfor (const item of page.data) {\n console.log(item.id, item.type);\n}\n" security: - ApiKey: [] post: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "addItems" operationId: "AddAnnotationQueueItems" x-cli-group: "annotation-queues" x-cli-name: "addItems" summary: "Add items to an annotation queue" description: "Adds items to the specified annotation queue." parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: items: type: "array" items: type: "object" properties: span_id: type: "string" trace_id: type: "string" required: - "span_id" - "trace_id" minItems: 1 maxItems: 1000 description: "The spans to add to the annotation queue" required: - "items" responses: "200": description: "Annotation queue items added." content: application/json: schema: type: "array" items: type: "object" properties: _id: type: "string" annotation_queue_id: type: "string" description: "The unique identifier of the annotation queue" workspace_id: type: "string" description: "The unique identifier of the workspace it belongs to" used_human_review_ids: type: "array" items: type: "string" description: "The unique identifiers of the human reviews that have been used to annotate the item" span_id: type: "string" trace_id: type: "string" description: "The trace identifier this span belongs to" type: type: "string" enum: - "span" required: - "_id" - "annotation_queue_id" - "workspace_id" - "span_id" - "type" x-code-samples: - lang: "curl" label: "Core - Add span items to a queue" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX/items' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"items\": [\n { \"span_id\": \"span_01\", \"trace_id\": \"trace_01\" },\n { \"span_id\": \"span_02\", \"trace_id\": \"trace_02\" }\n ]\n }'\n" - lang: "python" label: "Python - Add span items to a queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.annotation_queues.add_items(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n items=[\n {\"span_id\": \"span_01\", \"trace_id\": \"trace_01\"},\n {\"span_id\": \"span_02\", \"trace_id\": \"trace_02\"},\n ],\n)\n\nprint(f\"added {len(result)} items\")\n" - lang: "typescript" label: "Node.js - Add span items to a queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst result = await client.annotationQueues.addItems({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n items: [\n { spanId: 'span_01', traceId: 'trace_01' },\n { spanId: 'span_02', traceId: 'trace_02' },\n ],\n});\n\nconsole.log(`added ${result.length} items`);\n" security: - ApiKey: [] /v2/annotation-queues/{annotation_queue_id}/items/remove: post: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "removeItems" operationId: "RemoveAnnotationQueueItems" x-cli-group: "annotation-queues" x-cli-name: "removeItems" summary: "Remove annotation queue items" description: "Removes items from the specified annotation queue." parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" requestBody: content: application/json: schema: type: "object" properties: span_ids: type: "array" items: type: "string" minItems: 1 maxItems: 1000 description: "The unique identifiers of the spans to be removed from the annotation queue" required: - "span_ids" responses: "204": description: "No content - Annotation queue items successfully removed" "404": description: "Annotation queue not found" x-code-samples: - lang: "curl" label: "Core - Remove span items from a queue" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX/items/remove' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"span_ids\": [\"span_01\", \"span_02\"]\n }'\n" - lang: "python" label: "Python - Remove span items from a queue" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.annotation_queues.remove_items(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n span_ids=[\"span_01\", \"span_02\"],\n)\n" - lang: "typescript" label: "Node.js - Remove span items from a queue" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nawait client.annotationQueues.removeItems({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n spanIds: ['span_01', 'span_02'],\n});\n" security: - ApiKey: [] /v2/annotation-queues/{annotation_queue_id}/items/{item_id}: get: tags: - "Annotation Queues" x-speakeasy-group: "annotationQueues" x-speakeasy-name-override: "retrieveItem" operationId: "RetrieveAnnotationQueueItem" x-cli-group: "annotation-queues" x-cli-name: "getItem" summary: "Retrieve an annotation queue item" description: "Retrieves an item from the specified annotation queue in its expanded form. An annotation queue item is a pointer to a span; this endpoint returns the fully resolved span the item references." parameters: - schema: type: "string" required: true name: "annotation_queue_id" in: "path" - schema: type: "string" required: true name: "item_id" in: "path" responses: "200": description: "Annotation queue item retrieved." content: application/json: schema: oneOf: - type: "object" properties: _id: type: "string" default: "01KZEAE71XPXKP62RGZFZYR39N" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "generic" default: "generic" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.107Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.107Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.108Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.108Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.109Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.109Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.110Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.110Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.110Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.110Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.111Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.111Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.112Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.112Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.113Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.113Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.121Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.121Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.122Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.122Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.123Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.123Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.123Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.123Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.124Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.124Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.126Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.126Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.126Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.126Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.127Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.128Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.128Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.129Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.generic" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE73VGE0YCSYABC86KRY2" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "chat_completion" default: "chat_completion" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.168Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.168Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.169Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.169Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.170Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.170Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.170Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.170Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.171Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.171Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.172Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.172Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.173Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.173Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.173Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.173Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.174Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.174Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.175Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.175Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.176Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.176Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.177Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.177Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.177Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.177Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.179Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.179Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.179Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.179Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.180Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.181Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.181Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.182Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.chat_completion" input: allOf: - type: "object" properties: variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" knowledge_bases: type: "array" items: type: "object" additionalProperties: {} retrievals: type: "array" items: type: "object" additionalProperties: {} - oneOf: - type: "object" properties: 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far." model: type: "string" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." metadata: type: "object" additionalProperties: type: "string" maxLength: 512 description: "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can have a maximum length of 64 characters and values can have a maximum length of 512 characters." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." 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 call." 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" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" additionalProperties: type: "boolean" required: - "type" - "properties" description: "The parameters the functions accepts, described as a JSON Schema object" strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the function call. " required: - "name" required: - "function" description: "A list of tools the model may call." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." variables: type: "object" additionalProperties: {} description: "Variables to substitute in message templates. Uses f-string syntax ({{variableName}}) by default. For advanced templating with Jinja or Mustache syntax, use in conjunction with `template_engine`." example: customer_name: "John Smith" product_name: "Premium Plan" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" inputs: anyOf: - type: "object" additionalProperties: {} - type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" required: - "key" deprecated: true description: "@deprecated Use top-level `variables` field instead. Values to replace in the prompt messages using {{variableName}} syntax." example: customer_name: "John Smith" product_name: "Premium Plan" issue_type: "billing" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." knowledge_bases: type: "array" items: type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" query: type: "string" description: "The query to use to search the knowledge base. If not provided we will use the last user message from the messages of the requests" required: - "knowledge_id" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." description: "Leverage Orq's intelligent routing capabilities to enhance your AI application with enterprise-grade reliability and observability. Orq provides automatic request management including retries on failures, model fallbacks for high availability, identity-level analytics tracking, conversation threading, and dynamic prompt templating with variable substitution." deprecated: true example: retry: count: 3 on_codes: - 429 - 500 - 502 fallbacks: - model: "openai/gpt-5" - model: "anthropic/claude-4-opus" identity: id: "identity_01ARZ3NDEKTSV4RRFFQ69G5FAV" display_name: "Jane Doe" email: "jane.doe@example.com" thread: id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: - "customer-support" inputs: customer_name: "John Smith" issue_type: "billing" cache: ttl: 3600 type: "exact_match" knowledge_bases: - knowledge_id: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV" top_k: 5 timeout: call_timeout: 30000 security: mask: - "input" - "system" stream: type: "boolean" enum: - true description: "If set to true, the response will be streamed in chunks." required: - "messages" - "model" - "stream" - type: "object" properties: 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: "#/components/schemas/TextContentPartSchema" refusal: "#/components/schemas/RefusalPartSchema" reasoning: "#/components/schemas/ReasoningPartSchema" redacted_reasoning: "#/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: "#/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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by `Anthropic` Claude models." required: - "type" required: - "role" - "content" - "tool_call_id" title: "Tool message" description: "A list of messages comprising the conversation so far." model: type: "string" description: "Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the (Supported models)[/docs/proxy/supported-models] to browse available models." metadata: type: "object" additionalProperties: type: "string" maxLength: 512 description: "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can have a maximum length of 64 characters and values can have a maximum length of 512 characters." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." audio: type: - "object" - "null" properties: voice: type: "string" enum: - "alloy" - "echo" - "fable" - "onyx" - "nova" - "shimmer" description: "The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer." format: type: "string" enum: - "wav" - "mp3" - "flac" - "opus" - "pcm16" description: "Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16." required: - "voice" - "format" description: "Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more." frequency_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "integer" - "null" description: "`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. \n\n This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models." max_completion_tokens: type: - "integer" - "null" exclusiveMinimum: 0 description: "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message." top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used." n: type: - "integer" - "null" minimum: 1 description: "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs." presence_penalty: type: - "number" - "null" description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." response_format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" required: - "type" title: "Text" description: "\n\nDefault response format. Used to generate text responses" - type: "object" properties: type: type: "string" enum: - "json_object" required: - "type" title: "JSON object" description: "\n\nJSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so." - type: "object" properties: type: type: "string" enum: - "json_schema" json_schema: type: "object" properties: description: type: "string" description: "A description of what the response format is for, used by the model to determine how to respond in the format." name: type: "string" description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." schema: description: "The schema for the response format, described as a JSON Schema object." strict: type: "boolean" default: false description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true." required: - "name" required: - "type" - "json_schema" title: "JSON schema" description: "\n\nJSON Schema response format. Used to generate structured JSON responses" description: "An object specifying the format that the model must output" reasoning_effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.\n\n- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.\n- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.\n- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.\n- `xhigh` is currently only supported for `gpt-5.1-codex-max`.\n\nAny of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\"." verbosity: type: "string" description: "Adjusts response verbosity. Lower levels yield shorter answers." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" maxItems: 4 - type: "null" description: "Up to 4 sequences where the API will stop generating further tokens." stream_options: type: - "object" - "null" properties: include_usage: type: "boolean" description: "If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value." description: "Options for streaming response. Only set this when you set stream: true." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" discriminator: propertyName: "type" mapping: disabled: "#/components/schemas/ThinkingConfigDisabledSchema" enabled: "#/components/schemas/ThinkingConfigEnabledSchema" adaptive: "#/components/schemas/ThinkingConfigAdaptiveSchema" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. " top_k: type: - "number" - "null" description: "Limits the model to consider only the top k most likely tokens at each step." 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 call." 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" properties: type: type: "string" enum: - "object" properties: type: "object" additionalProperties: {} required: type: "array" items: type: "string" additionalProperties: type: "boolean" required: - "type" - "properties" description: "The parameters the functions accepts, described as a JSON Schema object" strict: type: "boolean" description: "Whether to enable strict schema adherence when generating the function call. " required: - "name" required: - "function" description: "A list of tools the model may call." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - 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 call." required: - "name" required: - "function" description: "Controls which (if any) tool is called by the model." parallel_tool_calls: type: "boolean" description: "Whether to enable parallel function calling during tool use." modalities: type: - "array" - "null" items: type: "string" enum: - "text" - "audio" description: "Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]." guardrails: type: "array" items: type: "object" properties: id: anyOf: - type: "string" enum: - "orq_pii_detection" - "orq_secret_detection" - "orq_sexual_moderation" - "orq_harmful_moderation" description: "The key of the guardrail." - type: "string" description: "Unique key or identifier of the evaluator" execute_on: type: "string" enum: - "input" - "output" description: "Determines whether the guardrail runs on the input (user message) or output (model response)." required: - "id" - "execute_on" description: "A list of guardrails to apply to the request." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" - $ref: "#/components/schemas/ResponseHealingPlugin" description: "Request-scoped transforms applied to the text exchanged with the model. Supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and `response_healing`, which repairs malformed JSON in non-streaming output." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." variables: type: "object" additionalProperties: {} description: "Variables to substitute in message templates. Uses f-string syntax ({{variableName}}) by default. For advanced templating with Jinja or Mustache syntax, use in conjunction with `template_engine`." example: customer_name: "John Smith" product_name: "Premium Plan" 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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." prompt_cache_key: type: "string" description: "Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the legacy `user` field for prompt caching." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" inputs: anyOf: - type: "object" additionalProperties: {} - type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" required: - "key" deprecated: true description: "@deprecated Use top-level `variables` field instead. Values to replace in the prompt messages using {{variableName}} syntax." example: customer_name: "John Smith" product_name: "Premium Plan" issue_type: "billing" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." knowledge_bases: type: "array" items: type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" query: type: "string" description: "The query to use to search the knowledge base. If not provided we will use the last user message from the messages of the requests" required: - "knowledge_id" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." description: "Leverage Orq's intelligent routing capabilities to enhance your AI application with enterprise-grade reliability and observability. Orq provides automatic request management including retries on failures, model fallbacks for high availability, identity-level analytics tracking, conversation threading, and dynamic prompt templating with variable substitution." deprecated: true example: retry: count: 3 on_codes: - 429 - 500 - 502 fallbacks: - model: "openai/gpt-5" - model: "anthropic/claude-4-opus" identity: id: "identity_01ARZ3NDEKTSV4RRFFQ69G5FAV" display_name: "Jane Doe" email: "jane.doe@example.com" thread: id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: - "customer-support" inputs: customer_name: "John Smith" issue_type: "billing" cache: ttl: 3600 type: "exact_match" knowledge_bases: - knowledge_id: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV" top_k: 5 timeout: call_timeout: 30000 security: mask: - "input" - "system" stream: type: "boolean" enum: - false description: "If set to false, the response will be returned in one chunk." required: - "messages" - "model" - "stream" output: type: "object" properties: id: type: "string" description: "A unique identifier for the chat completion." choices: type: "array" items: type: "object" properties: finish_reason: type: - "string" - "null" enum: - "stop" - "length" - "tool_calls" - "content_filter" - "function_call" - null description: "The reason the model stopped generating tokens." index: type: "number" default: 0 description: "The index of the choice in the list of choices." message: type: "object" properties: content: type: - "string" - "null" refusal: type: - "string" - "null" tool_calls: type: "array" items: type: "object" properties: index: type: "number" id: type: "string" type: type: "string" enum: - "function" 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." 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." role: type: "string" enum: - "assistant" reasoning: type: - "string" - "null" description: "Internal thought process of the model" reasoning_signature: type: - "string" - "null" 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." audio: type: - "object" - "null" properties: id: type: "string" expires_at: type: "integer" data: type: "string" transcript: type: "string" required: - "id" - "expires_at" - "data" - "transcript" description: "If the audio output modality is requested, this object contains data about the audio response from the model." description: "A chat completion message generated by the model." logprobs: type: - "object" - "null" properties: content: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message content tokens with log probability information." refusal: type: - "array" - "null" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." top_logprobs: type: "array" items: type: "object" properties: token: type: "string" description: "The token." logprob: type: "number" description: "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely." bytes: type: - "array" - "null" items: type: "number" description: "A list of integers representing the UTF-8 bytes representation of the token." required: - "token" - "logprob" - "bytes" description: "List of the most likely tokens and their log probability, at this token position." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "A list of message refusal tokens with log probability information." required: - "content" - "refusal" description: "Log probability information for the choice." required: - "finish_reason" - "message" description: "A list of chat completion choices. Can be more than one if n is greater than 1." created: type: "number" description: "The Unix timestamp (in seconds) of when the chat completion was created." model: type: "string" description: "The model used for the chat completion." system_fingerprint: type: - "string" - "null" description: "This fingerprint represents the backend configuration that the model runs with." usage: type: - "object" - "null" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Usage statistics for the completion request." object: type: "string" enum: - "chat.completion" output_masking: type: "boolean" required: - "id" - "choices" - "created" - "model" - "object" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE76NKSCXTEG1HR8XH1JH" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "completion" default: "completion" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.263Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.263Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.265Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.265Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.266Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.266Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.268Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.268Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.269Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.269Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.278Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.278Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.281Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.281Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.282Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.282Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.282Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.282Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.283Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.283Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.284Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.284Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.285Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.285Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.286Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.286Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.287Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.287Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.288Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.288Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.289Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.289Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.290Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.291Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.completion" input: type: "object" properties: variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" knowledge_bases: type: "array" items: type: "object" additionalProperties: {} retrievals: type: "array" items: type: "object" additionalProperties: {} model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays." echo: type: - "boolean" - "null" default: false description: "Echo back the prompt in addition to the completion" frequency_penalty: type: - "number" - "null" default: 0 description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." max_tokens: type: - "number" - "null" default: 16 description: "The maximum number of tokens that can be generated in the completion." presence_penalty: type: - "number" - "null" minimum: -2 maximum: 2 default: 0 description: "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics." seed: type: - "number" - "null" description: "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result." stop: anyOf: - type: "string" - type: "array" items: type: "string" - type: "null" default: null description: "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence." stream: type: - "boolean" - "null" default: false description: "Whether to stream back partial progress." temperature: type: - "number" - "null" default: 1 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" default: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered." n: type: - "number" - "null" default: 1 description: "How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota." user: type: "string" description: "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" - type: "null" description: "Configuration for the thinking mode capability. Set type to `adaptive` for models that support adaptive thinking (e.g. Claude Opus 4.6, Sonnet 4.6), or `enabled` with `budget_tokens` for manual control." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" inputs: anyOf: - type: "object" additionalProperties: {} - type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" required: - "key" deprecated: true description: "@deprecated Use top-level `variables` field instead. Values to replace in the prompt messages using {{variableName}} syntax." example: customer_name: "John Smith" product_name: "Premium Plan" issue_type: "billing" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." knowledge_bases: type: "array" items: type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return. If not provided, will default to the knowledge base configured `top_k`." threshold: type: "number" minimum: 0 maximum: 1 description: "The threshold to apply to the search. If not provided, will default to the knowledge base configured `threshold`" search_type: type: "string" enum: - "vector_search" - "keyword_search" - "hybrid_search" default: "hybrid_search" description: "The type of search to perform. If not provided, will default to the knowledge base configured `retrieval_type`" filter_by: 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: "The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge/api#knowledge-base-search) for more information." search_options: type: "object" properties: include_vectors: type: "boolean" description: "Whether to include the vector in the chunk" include_metadata: type: "boolean" description: "Whether to include the metadata in the chunk" include_scores: type: "boolean" description: "Whether to include the scores in the chunk" description: "Additional search options" rerank_config: type: "object" properties: model: type: "string" description: "The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/rerank-models)." example: "cohere/rerank-multilingual-v3.0" threshold: type: "number" minimum: 0 maximum: 1 default: 0 description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" top_k: type: "integer" minimum: 1 maximum: 100 default: 10 description: "The number of top results to return after reranking. If not provided, will default to the knowledge base configured `top_k`." required: - "model" description: "Override the rerank configuration for this search. If not provided, will use the knowledge base configured rerank settings." agentic_rag_config: type: "object" properties: model: type: "string" description: "The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/proxy#/chat-models)." required: - "model" description: "Override the agentic RAG configuration for this search. If not provided, will use the knowledge base configured agentic RAG settings." knowledge_id: type: "string" description: "Unique identifier of the knowledge base to search" example: "customer-knowledge-base" query: type: "string" description: "The query to use to search the knowledge base. If not provided we will use the last user message from the messages of the requests" required: - "knowledge_id" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." description: "Leverage Orq's intelligent routing capabilities to enhance your AI application with enterprise-grade reliability and observability. Orq provides automatic request management including retries on failures, model fallbacks for high availability, identity-level analytics tracking, conversation threading, and dynamic prompt templating with variable substitution." deprecated: true example: retry: count: 3 on_codes: - 429 - 500 - 502 fallbacks: - model: "openai/gpt-5" - model: "anthropic/claude-4-opus" identity: id: "identity_01ARZ3NDEKTSV4RRFFQ69G5FAV" display_name: "Jane Doe" email: "jane.doe@example.com" thread: id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: - "customer-support" inputs: customer_name: "John Smith" issue_type: "billing" cache: ttl: 3600 type: "exact_match" knowledge_bases: - knowledge_id: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV" top_k: 5 timeout: call_timeout: 30000 security: mask: - "input" - "system" required: - "model" - "prompt" output: type: "object" properties: id: type: "string" description: "A unique identifier for the completion." choices: type: "array" items: type: "object" properties: finish_reason: type: "string" enum: - "stop" - "length" - "content_filter" - "tool_calls" description: "The reason the model stopped generating tokens." index: type: "number" description: "The index of the choice in the list of choices." text: type: "string" required: - "finish_reason" - "index" - "text" description: "The list of completion choices the model generated for the input prompt." created: anyOf: - type: "string" - type: "number" description: "The Unix timestamp (in seconds) of when the chat completion was created." model: type: "string" description: "The model used for the chat completion." system_fingerprint: type: "string" description: "This fingerprint represents the backend configuration that the model runs with." object: type: "string" description: "The object type" usage: type: "object" properties: completion_tokens: type: "number" description: "Number of tokens in the generated completion." prompt_tokens: type: "number" description: "Number of tokens in the prompt." total_tokens: type: "number" description: "Total number of tokens used in the request (prompt + completion)." prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "integer" - "null" cache_creation_tokens: type: - "integer" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio input tokens consumed by the request." completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" accepted_prediction_tokens: type: - "number" - "null" rejected_prediction_tokens: type: - "number" - "null" audio_tokens: type: - "integer" - "null" description: "The number of audio output tokens produced by the response." description: "Usage statistics for the completion request." output_masking: type: "boolean" required: - "id" - "choices" - "model" - "object" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7960GQ731GWQ4J62TXB" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "embedding" default: "embedding" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.339Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.339Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.340Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.340Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.341Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.341Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.342Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.342Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.343Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.343Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.343Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.343Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.344Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.344Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.345Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.345Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.346Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.346Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.346Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.346Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.354Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.354Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.355Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.355Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.356Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.356Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.357Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.357Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.358Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.358Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.358Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.359Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.360Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.360Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.embedding" input: type: "object" properties: input: anyOf: - type: "string" minLength: 1 - type: "array" items: type: "string" minLength: 1 minItems: 1 description: "Input text to embed, encoded as a string or array of tokens." model: type: "string" description: "ID of the model to use" encoding_format: type: "string" enum: - "base64" - "float" default: "float" description: "Type of the document element" dimensions: type: "number" description: "The number of dimensions the resulting output embeddings should have." user: type: "string" description: "A unique identifier representing your end-user" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/text-embedding-3-small" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "input" - "model" output: type: "object" properties: object: type: "string" enum: - "list" data: type: "array" items: type: "object" properties: object: type: "string" enum: - "embedding" description: "The object type, which is always `embedding`." embedding: anyOf: - type: "array" items: type: "number" - type: "string" description: "The embedding vector, which is a list of floats. The length of vector depends on the model." index: type: "number" description: "The index of the embedding in the list of embeddings." required: - "object" - "embedding" - "index" model: type: "string" description: "ID of the model to used." usage: type: "object" properties: prompt_tokens: type: "number" description: "The number of tokens used by the prompt." total_tokens: type: "number" description: "The total number of tokens used by the request." required: - "prompt_tokens" - "total_tokens" description: "The usage information for the request." required: - "object" - "data" - "model" - "usage" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7B2DDT8X07PQ29F3GTA" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "create_image" default: "create_image" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" object_ids: type: "array" items: type: "string" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.400Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.400Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.400Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.401Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.401Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.401Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.402Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.402Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.403Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.403Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.403Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.403Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.404Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.404Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.405Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.405Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.406Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.406Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.407Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.407Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.408Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.408Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.408Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.408Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.409Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.409Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.410Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.410Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.411Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.411Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.412Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.413Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.413Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.414Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.create_image" input: type: "object" properties: variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" knowledge_bases: type: "array" items: type: "object" additionalProperties: {} retrievals: type: "array" items: type: "object" additionalProperties: {} prompt: type: "string" description: "A text description of the desired image(s)." background: type: - "string" - "null" enum: - "transparent" - "opaque" - "auto" - null description: "Allows to set transparency for the background of the generated image(s). This parameter is only supported for `openai/gpt-image-1`." model: type: "string" description: "The model to use for image generation. One of `openai/dall-e-2`, `openai/dall-e-3`, or `openai/gpt-image-1`." moderation: type: - "string" - "null" enum: - "low" - "auto" - null description: "Control the content-moderation level for images generated by `gpt-image-1`. Must be either `low` or `auto`." n: type: - "integer" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported." output_compression: type: - "integer" - "null" minimum: 0 maximum: 100 description: "The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats." output_format: type: - "string" - "null" enum: - "png" - "jpeg" - "webp" - null description: "The format in which the generated images are returned. This parameter is only supported for `openai/gpt-image-1`." quality: type: - "string" - "null" enum: - "auto" - "high" - "medium" - "low" - "hd" - "standard" - null description: "The quality of the image that will be generated. `auto` will automatically select the best quality for the given model." response_format: type: - "string" - "null" enum: - "url" - "b64_json" - null description: "The format in which generated images are returned. Must be one of `url` or `b64_json`. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images." size: type: - "string" - "null" description: "The size of the generated images. Must be one of the specified sizes for each model." style: type: - "string" - "null" enum: - "vivid" - "natural" - null description: "The style of the generated images. This parameter is only supported for `openai/dall-e-3`. Must be one of `vivid` or `natural`." metadata: type: "object" additionalProperties: type: "string" maxLength: 512 description: "Optional metadata for the request. This metadata will be stored in the trace and can be used for filtering." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "prompt" - "model" output: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." data: type: "array" items: type: "object" properties: revised_prompt: type: - "string" - "null" description: "The prompt that was used to generate the image, if there was any revision to the prompt." b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if `response_format` is `b64_json`" url: type: "string" description: "The url of the generated image, if `response_format` is `url` (default)" description: "Represents the url or the content of an image generated." usage: type: "object" properties: input_tokens: type: "number" input_tokens_details: type: "object" properties: image_tokens: type: "number" text_tokens: type: "number" output_tokens: type: "number" total_tokens: type: "number" required: - "input_tokens_details" output_masking: type: "boolean" required: - "created" - "data" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7CXH1E9Z173SD361YS8" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "create_image_edit" default: "create_image_edit" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" object_ids: type: "array" items: type: "string" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.458Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.458Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.459Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.459Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.460Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.460Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.461Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.461Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.469Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.469Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.469Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.469Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.470Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.470Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.471Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.471Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.472Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.472Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.473Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.473Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.474Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.474Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.475Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.475Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.476Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.476Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.477Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.477Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.478Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.478Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.479Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.479Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.480Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.481Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.create_image_edit" input: type: "object" properties: variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" knowledge_bases: type: "array" items: type: "object" additionalProperties: {} retrievals: type: "array" items: type: "object" additionalProperties: {} model: type: "string" description: "The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway-supported-models#image-models)" image: description: "The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images." prompt: type: "string" description: "A text description of the desired image(s)." n: type: - "number" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10." size: type: - "string" - "null" description: "The size of the generated images" quality: type: - "string" - "null" enum: - "auto" - "high" - "medium" - "low" - "standard" - null description: "The quality of the image that will be generated. Auto will automatically select the best quality for the given model." response_format: type: "string" enum: - "url" - "b64_json" description: "The format in which the generated images are returned. Some of the models only return the image in base64 format." user: type: "string" description: "A unique identifier representing your end-user, which can help to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "model" - "prompt" output: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." output_format: type: "string" description: "The output format of the image generation" size: type: "string" description: "The size of the image generated" quality: type: "string" description: "The quality of the image generated" data: type: "array" items: type: "object" properties: b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if response_format is b64_json" url: type: "string" description: "The URL of the generated image, if response_format is url (default)" description: "The list of generated images." usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens (images and text) used for the image generation." input_tokens: type: "number" description: "The number of tokens (images and text) in the input prompt." output_tokens: type: "number" description: "The number of output tokens generated by the model." input_tokens_details: type: "object" properties: text_tokens: type: "number" description: "The number of text tokens in the input prompt." image_tokens: type: "number" description: "The number of image tokens in the input prompt." required: - "text_tokens" - "image_tokens" description: "The input tokens detailed information for the image generation." required: - "total_tokens" - "input_tokens" - "output_tokens" - "input_tokens_details" description: "The token usage information for the image generation." output_masking: type: "boolean" required: - "created" - "data" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7FBS2JR5XSTTQBQPZ5J" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "create_image_variation" default: "create_image_variation" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" object_ids: type: "array" items: type: "string" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.536Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.537Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.537Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.537Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.538Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.538Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.539Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.539Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.540Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.540Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.540Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.540Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.541Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.541Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.542Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.542Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.543Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.543Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.544Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.544Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.544Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.544Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.545Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.545Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.546Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.546Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.547Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.547Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.548Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.548Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.549Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.549Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.550Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.558Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.create_image_variation" input: type: "object" properties: image: description: "The image to edit. Must be a supported image file. It should be a png, webp, or jpg file less than 50MB." model: type: "string" description: "The model to use for image generation." n: type: - "number" - "null" minimum: 1 maximum: 10 default: 1 description: "The number of images to generate. Must be between 1 and 10." response_format: type: "string" enum: - "url" - "b64_json" default: "url" description: "The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated." size: type: "string" enum: - "256x256" - "512x512" - "1024x1024" default: "1024x1024" description: "The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`." user: type: "string" description: "A unique identifier representing your end-user, which can help to monitor and detect abuse." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" prompt: type: "object" properties: id: type: "string" description: "Unique identifier of the prompt to use" example: "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV" version: type: "string" enum: - "latest" description: "Version of the prompt to use (currently only \"latest\" supported)" example: "latest" required: - "id" - "version" description: "Prompt configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "model" output: type: "object" properties: created: type: "number" description: "The Unix timestamp (in seconds) of when the image was created." output_format: type: "string" description: "The output format of the image generation" size: type: "string" description: "The size of the image generated" quality: type: "string" description: "The quality of the image generated" data: type: "array" items: type: "object" properties: b64_json: type: "string" description: "The base64-encoded JSON of the generated image, if response_format is b64_json" url: type: "string" description: "The URL of the generated image, if response_format is url (default)" description: "The list of generated images." usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens (images and text) used for the image generation." input_tokens: type: "number" description: "The number of tokens (images and text) in the input prompt." output_tokens: type: "number" description: "The number of output tokens generated by the model." input_tokens_details: type: "object" properties: text_tokens: type: "number" description: "The number of text tokens in the input prompt." image_tokens: type: "number" description: "The number of image tokens in the input prompt." required: - "text_tokens" - "image_tokens" description: "The input tokens detailed information for the image generation." required: - "total_tokens" - "input_tokens" - "output_tokens" - "input_tokens_details" description: "The token usage information for the image generation." output_masking: type: "boolean" required: - "created" - "data" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7H6TZAG6V94PTJWZ6JE" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "moderation" default: "moderation" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.603Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.603Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.604Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.604Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.604Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.604Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.605Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.605Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.606Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.606Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.607Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.607Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.607Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.607Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.608Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.608Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.609Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.609Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.610Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.610Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.611Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.611Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.611Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.611Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.612Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.612Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.613Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.613Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.614Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.614Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.615Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.615Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.616Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.617Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.moderation" input: type: "object" properties: input: anyOf: - type: "string" - type: "array" items: type: "string" description: "Input (or inputs) to classify. Can be a single string, an array of strings, or an array of multi-modal input objects similar to other models." model: type: "string" description: "The content moderation model you would like to use. Defaults to omni-moderation-latest" required: - "input" - "model" output: type: "object" properties: id: type: "string" description: "The unique identifier for the moderation request" model: type: "string" description: "The model used to generate the moderation results" results: type: "array" items: anyOf: - type: "object" properties: flagged: type: "boolean" description: "Whether any of the categories are flagged" categories: type: "object" properties: hate: type: "boolean" description: "Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste." hate/threatening: type: "boolean" description: "Hateful content that also includes violence or serious harm towards the targeted group." harassment: type: "boolean" description: "Content that expresses, incites, or promotes harassing language towards any target." harassment/threatening: type: "boolean" description: "Harassment content that also includes violence or serious harm towards any target." illicit: type: "boolean" description: "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing." illicit/violent: type: "boolean" description: "Content that includes instructions or advice that facilitate the planning or execution of wrongdoing that also includes violence." self-harm: type: "boolean" description: "Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders." self-harm/intent: type: "boolean" description: "Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm." self-harm/instructions: type: "boolean" description: "Content that encourages performing acts of self-harm, or that gives instructions or advice on how to commit such acts." sexual: type: "boolean" description: "Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services." sexual/minors: type: "boolean" description: "Sexual content that includes an individual who is under 18 years old." violence: type: "boolean" description: "Content that depicts death, violence, or physical injury." violence/graphic: type: "boolean" description: "Content that depicts death, violence, or physical injury in graphic detail." required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories, and whether they are flagged or not" category_scores: type: "object" properties: hate: type: "number" description: "The score for the category hate" hate/threatening: type: "number" description: "The score for the category hate/threatening" harassment: type: "number" description: "The score for the category harassment" harassment/threatening: type: "number" description: "The score for the category harassment/threatening" illicit: type: "number" description: "The score for the category illicit" illicit/violent: type: "number" description: "The score for the category illicit/violent" self-harm: type: "number" description: "The score for the category self-harm" self-harm/intent: type: "number" description: "The score for the category self-harm/intent" self-harm/instructions: type: "number" description: "The score for the category self-harm/instructions" sexual: type: "number" description: "The score for the category sexual" sexual/minors: type: "number" description: "The score for the category sexual/minors" violence: type: "number" description: "The score for the category violence" violence/graphic: type: "number" description: "The score for the category violence/graphic" required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories along with their scores as predicted by model" category_applied_input_types: type: "object" properties: hate: type: "array" items: type: "string" description: "The applied input type(s) for the category hate" hate/threatening: type: "array" items: type: "string" description: "The applied input type(s) for the category hate/threatening" harassment: type: "array" items: type: "string" description: "The applied input type(s) for the category harassment" harassment/threatening: type: "array" items: type: "string" description: "The applied input type(s) for the category harassment/threatening" illicit: type: "array" items: type: "string" description: "The applied input type(s) for the category illicit" illicit/violent: type: "array" items: type: "string" description: "The applied input type(s) for the category illicit/violent" self-harm: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm" self-harm/intent: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm/intent" self-harm/instructions: type: "array" items: type: "string" description: "The applied input type(s) for the category self-harm/instructions" sexual: type: "array" items: type: "string" description: "The applied input type(s) for the category sexual" sexual/minors: type: "array" items: type: "string" description: "The applied input type(s) for the category sexual/minors" violence: type: "array" items: type: "string" description: "The applied input type(s) for the category violence" violence/graphic: type: "array" items: type: "string" description: "The applied input type(s) for the category violence/graphic" required: - "hate" - "hate/threatening" - "harassment" - "harassment/threatening" - "illicit" - "illicit/violent" - "self-harm" - "self-harm/intent" - "self-harm/instructions" - "sexual" - "sexual/minors" - "violence" - "violence/graphic" description: "A list of the categories along with the input type(s) that the score applies to" required: - "flagged" - "categories" - "category_scores" - type: "object" properties: categories: type: "object" properties: sexual: type: "boolean" description: "Sexual content detected" hate_and_discrimination: type: "boolean" description: "Hate and discrimination content detected" violence_and_threats: type: "boolean" description: "Violence and threats content detected" dangerous_and_criminal_content: type: "boolean" description: "Dangerous and criminal content detected" selfharm: type: "boolean" description: "Self-harm content detected" health: type: "boolean" description: "Unqualified health advice detected" financial: type: "boolean" description: "Unqualified financial advice detected" law: type: "boolean" description: "Unqualified legal advice detected" pii: type: "boolean" description: "Personally identifiable information detected" required: - "sexual" - "hate_and_discrimination" - "violence_and_threats" - "dangerous_and_criminal_content" - "selfharm" - "health" - "financial" - "law" - "pii" description: "A list of the categories, and whether they are flagged or not" category_scores: type: "object" properties: sexual: type: "number" description: "The score for sexual content" hate_and_discrimination: type: "number" description: "The score for hate and discrimination content" violence_and_threats: type: "number" description: "The score for violence and threats content" dangerous_and_criminal_content: type: "number" description: "The score for dangerous and criminal content" selfharm: type: "number" description: "The score for self-harm content" health: type: "number" description: "The score for unqualified health advice" financial: type: "number" description: "The score for unqualified financial advice" law: type: "number" description: "The score for unqualified legal advice" pii: type: "number" description: "The score for personally identifiable information" required: - "sexual" - "hate_and_discrimination" - "violence_and_threats" - "dangerous_and_criminal_content" - "selfharm" - "health" - "financial" - "law" - "pii" description: "A list of the categories along with their scores as predicted by model" required: - "categories" - "category_scores" description: "A list of moderation objects" required: - "id" - "model" - "results" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7K55RW6M5KKSA9XH3F1" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "ocr" default: "ocr" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.662Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.663Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.664Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.664Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.666Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.666Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.666Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.666Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.667Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.667Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.668Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.668Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.669Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.669Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.670Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.670Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.670Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.670Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.671Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.671Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.672Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.672Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.680Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.680Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.681Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.681Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.682Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.682Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.683Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.683Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.683Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.684Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.685Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.685Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.ocr" input: type: "object" properties: model: type: "string" description: "ID of the model to use for OCR." document: anyOf: - type: "object" properties: type: type: "string" enum: - "document_url" document_url: type: "string" format: "uri" description: "URL of the document to process" document_name: type: "string" description: "The name of the document" required: - "type" - "document_url" - type: "object" properties: type: type: "string" enum: - "image_url" image_url: anyOf: - type: "string" description: "Base64 encoded image" - type: "object" properties: url: type: "string" format: "uri" detail: type: "string" required: - "url" description: "URL of the image to process" required: - "type" - "image_url" description: "Document to run OCR on. Can be a DocumentURLChunk or ImageURLChunk." pages: type: - "array" - "null" items: type: "integer" description: "Specific pages to process. Can be a single number, range, or list. Starts from 0. Null for all pages." ocr_settings: type: "object" properties: include_image_base64: type: - "boolean" - "null" description: "Whether to include image Base64 in the response. Null for default." max_images_to_include: type: "integer" description: "Maximum number of images to extract. Null for no limit." image_min_size: type: "integer" description: "Minimum height and width of image to extract. Null for no minimum." description: "Optional settings for the OCR run" required: - "model" - "document" output: type: "object" properties: model: type: "string" description: "ID of the model used for OCR." pages: type: "array" items: type: "object" properties: index: type: "number" description: "The page index in a pdf document starting from 0" markdown: type: "string" description: "The markdown string response of the page" images: type: "array" items: type: "object" properties: id: type: "string" description: "The id of the image" image_base64: type: - "string" - "null" description: "The base64 encoded image" required: - "id" dimensions: type: - "object" - "null" properties: dpi: type: "integer" description: "Dots per inch of the page-image" height: type: "integer" description: "Height of the image in pixels" width: type: "integer" description: "Width of the image in pixels" required: - "dpi" - "height" - "width" description: "The dimensions of the PDF Page's screenshot image" required: - "index" - "markdown" - "images" usage: oneOf: - type: "object" properties: type: type: "string" enum: - "pages" pages_processed: type: "integer" description: "The number of pages processed" required: - "type" - "pages_processed" description: "The usage information for the OCR run counted as pages processed" - type: "object" properties: type: type: "string" enum: - "tokens" tokens_processed: type: "integer" description: "The number of tokens processed" required: - "type" - "tokens_processed" description: "The usage information for the OCR run counted as tokens processed" required: - "model" - "pages" - "usage" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7N418PHTHEB2TZPS4H2" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "rerank" default: "rerank" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" costs: type: "number" description: "Total cost of the whole flow" input_tokens: type: "number" description: "Total of all input tokens used" latency: type: "number" description: "Total latency" total_tokens: type: "number" description: "Total input and output tokens" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.722Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.722Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.722Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.722Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.723Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.723Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.724Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.724Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.725Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.725Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.725Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.726Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.726Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.726Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.727Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.727Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.728Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.728Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.729Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.729Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.730Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.730Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.730Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.731Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.731Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.731Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.733Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.733Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.733Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.733Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.734Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.735Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.735Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.736Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.rerank" input: type: "object" properties: query: type: "string" description: "The search query" documents: type: "array" items: type: "string" description: "A list of texts that will be compared to the `query`. For optimal performance we recommend against sending more than 1,000 documents in a single request." model: type: "string" description: "The identifier of the model to use" top_n: type: "number" description: "The number of most relevant documents or indices to return, defaults to the length of the documents" filename: type: - "string" - "null" description: "The filename of the document to rerank" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." plugins: type: "array" items: anyOf: - $ref: "#/components/schemas/PIIRedactionPluginAuto" - $ref: "#/components/schemas/PIIRedactionPluginEn" - $ref: "#/components/schemas/PIIRedactionPluginNl" description: "Request-scoped transforms applied to the text exchanged with the model. Currently supports `pii_redaction`, which replaces PII with placeholders before the provider sees it and restores the original values in the response." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" cache: type: "object" properties: ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 type: type: "string" enum: - "exact_match" required: - "type" description: "Cache configuration for the request." retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "query" - "documents" - "model" output: type: "object" properties: response: type: "object" properties: id: type: "string" description: "A unique identifier for the rerank." object: type: "string" enum: - "list" results: type: "array" items: type: "object" properties: object: type: "string" enum: - "rerank" description: "The object type, which is always `rerank`." index: type: "number" description: "Corresponds to the index in the original list of documents to which the ranked document belongs." relevance_score: type: "number" description: "Relevance 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." document: type: "object" properties: text: type: "string" description: "The text of the document to rerank" required: - "text" description: "If return_documents is set as false this will return none, if true it will return the documents passed in" required: - "object" - "index" - "relevance_score" description: "An ordered list of ranked documents" usage: type: "object" properties: total_tokens: type: "number" description: "The total number of tokens used in the rerank" required: - "total_tokens" required: - "object" - "results" filename: type: - "string" - "null" required: - "response" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7PVWADD8GQPVJE0F1BG" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "speech" default: "speech" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.779Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.779Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.780Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.780Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.780Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.781Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.781Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.781Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.782Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.782Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.783Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.783Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.784Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.784Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.791Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.791Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.792Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.792Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.793Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.793Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.794Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.794Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.795Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.795Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.796Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.796Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.797Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.797Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.798Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.798Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.798Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.799Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.800Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.800Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.speech" input: type: "object" properties: input: type: "string" description: "The text to generate audio for. The maximum length is 4096 characters" model: type: "string" description: "ID of the model to use" voice: type: "string" description: "The voice to use. \n\n Available voices for OpenAI \n\n `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer` \n\n Available voices for ElevenLabs \n\n `aria`, `roger`, `sarah`, `laura`, `charlie`, `george`, `callum`, `river`, `liam`, `charlotte`, `alice`, `matilda`, `will`, `jessica`, `eric`, `chris`, `brian`, `daniel`, `lily`, `bill`" response_format: type: "string" enum: - "mp3" - "opus" - "aac" - "flac" - "wav" - "pcm" default: "mp3" description: "The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`. If a format is provided but not supported by the provider, the response will be in the default format. When the provided format is not supported by the provider, the response will be in the default format." speed: type: "number" default: 1 description: "The speed of the generated audio." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" thread: type: "object" properties: id: type: "string" description: "Unique thread identifier to group related invocations." example: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV" tags: type: "array" items: type: "string" description: "Optional tags to differentiate or categorize threads" example: - "customer-support" - "priority-high" required: - "id" description: "Thread information to group related requests" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." required: - "input" - "model" - "voice" output: type: "object" properties: url: type: "string" description: "URL of the speech created." required: - "url" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7S0WGJZYTQ8JZT8Y8CR" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "transcription" default: "transcription" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.845Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.845Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.846Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.846Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.847Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.847Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.848Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.848Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.848Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.848Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.849Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.849Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.850Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.850Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.851Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.851Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.851Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.851Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.852Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.852Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.853Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.853Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.854Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.854Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.854Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.854Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.856Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.856Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.857Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.857Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.857Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.858Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.859Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:07.859Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.transcription" input: type: "object" properties: model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." enable_logging: type: "boolean" default: true description: "When enable_logging is set to false, zero retention mode is used. This disables history features like request stitching and is only available to enterprise customers." diarize: type: "boolean" default: false description: "Whether to annotate which speaker is currently talking in the uploaded file." response_format: type: "string" enum: - "json" - "text" - "srt" - "verbose_json" - "vtt" description: "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt." tag_audio_events: type: "boolean" default: true description: "Whether to tag audio events like (laughter), (footsteps), etc. in the transcription." num_speakers: type: "number" description: "The maximum amount of speakers talking in the uploaded file. Helps with predicting who speaks when, the maximum is 32. " timestamps_granularity: type: "string" enum: - "none" - "word" - "character" default: "word" description: "The granularity of the timestamps in the transcription. Word provides word-level timestamps and character provides character-level timestamps per word." temperature: type: "number" example: 0.5 description: "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." language: type: "string" description: "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." timestamp_granularities: type: "array" items: type: "string" enum: - "word" - "segment" description: "The timestamp granularities to populate for this transcription. response_format must be set to verbose_json to use timestamp granularities. Either or both of these options are supported: \"word\" or \"segment\". Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency." example: - "word" - "segment" name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." url: type: "string" required: - "model" output: anyOf: - type: "object" properties: text: type: "string" required: - "text" - type: "object" properties: task: type: "string" language: type: "string" duration: type: "number" text: type: "string" words: type: "array" items: type: "object" properties: word: type: "string" start: type: "number" end: type: "number" segments: type: "array" items: type: "object" properties: id: type: "number" seek: type: "number" start: type: "number" end: type: "number" text: type: "string" tokens: type: "array" items: type: "number" temperature: type: "number" avg_logprob: type: "number" compression_ratio: type: "number" no_speech_prob: type: "number" required: - "id" - "seek" - "start" - "end" - "text" - "tokens" - "temperature" - "avg_logprob" - "compression_ratio" - "no_speech_prob" required: - "text" - type: "string" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE7XSFQEFE02SXRSS7F9N" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "translation" default: "translation" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.257Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.257Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.293Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.293Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.343Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.343Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.344Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.344Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.345Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.345Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.346Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.346Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.347Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.348Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.349Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.349Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.350Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.350Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.353Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.353Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.356Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.356Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.357Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.357Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.360Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.360Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.363Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.364Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.365Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.365Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.368Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.369Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.372Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.373Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.translation" input: type: "object" properties: model: type: "string" description: "ID of the model to use" prompt: type: "string" description: "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." enable_logging: type: "boolean" default: true description: "When enable_logging is set to false, zero retention mode is used. This disables history features like request stitching and is only available to enterprise customers." diarize: type: "boolean" default: false description: "Whether to annotate which speaker is currently talking in the uploaded file." response_format: type: "string" enum: - "json" - "text" - "srt" - "verbose_json" - "vtt" description: "The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt." tag_audio_events: type: "boolean" default: true description: "Whether to tag audio events like (laughter), (footsteps), etc. in the transcription." num_speakers: type: "number" description: "The maximum amount of speakers talking in the uploaded file. Helps with predicting who speaks when, the maximum is 32. " timestamps_granularity: type: "string" enum: - "none" - "word" - "character" default: "word" description: "The granularity of the timestamps in the transcription. Word provides word-level timestamps and character provides character-level timestamps per word." temperature: type: "number" example: 0.5 description: "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Load balancer configuration for the request." timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." orq: type: "object" properties: name: type: "string" description: "The name to display on the trace. If not specified, the default system name will be used." fallbacks: type: "array" items: type: "object" properties: model: type: "string" description: "Fallback model identifier" example: "openai/gpt-4o-mini" required: - "model" description: "Array of fallback models to use if primary model fails" retry: type: "object" properties: count: type: "number" minimum: 1 maximum: 5 default: 3 description: "Number of retry attempts (1-5)" example: 3 on_codes: type: "array" items: type: "number" minimum: 100 maximum: 599 minItems: 1 description: "HTTP status codes that trigger retry logic" example: - 429 - 500 - 502 - 503 - 504 description: "Retry configuration for the request" identity: $ref: "#/components/schemas/PublicIdentity" contact: $ref: "#/components/schemas/PublicContact" load_balancer: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" description: "Array of models with weights for load balancing requests" example: type: "weight_based" models: - model: "openai/gpt-4o" weight: 0.7 - model: "anthropic/claude-3-5-sonnet" weight: 0.3 timeout: type: "object" properties: call_timeout: type: "number" minimum: 1 description: "Timeout value in milliseconds" example: 30000 required: - "call_timeout" description: "Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured." url: type: "string" required: - "model" output: anyOf: - type: "object" properties: text: type: "string" required: - "text" - type: "object" properties: task: type: "string" language: type: "string" duration: type: "number" text: type: "string" words: type: "array" items: type: "object" properties: word: type: "string" start: type: "number" end: type: "number" segments: type: "array" items: type: "object" properties: id: type: "number" seek: type: "number" start: type: "number" end: type: "number" text: type: "string" tokens: type: "array" items: type: "number" temperature: type: "number" avg_logprob: type: "number" compression_ratio: type: "number" no_speech_prob: type: "number" required: - "id" - "seek" - "start" - "end" - "text" - "tokens" - "temperature" - "avg_logprob" - "compression_ratio" - "no_speech_prob" required: - "text" - type: "string" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8B7M4J21MYXMD61K99Z" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "llm_calls" default: "llm_calls" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.436Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.436Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.437Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.437Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.438Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.438Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.438Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.438Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.439Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.439Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.440Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.440Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.440Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.440Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.441Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.441Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.442Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.442Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.442Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.442Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.443Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.443Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.444Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.444Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.444Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.444Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.445Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.446Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.446Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.446Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.447Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.447Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.448Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.448Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "block.llm_call" input: type: "object" properties: 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" variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" tools: type: "array" items: 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. \n\n Omitting `parameters` defines a function with an empty parameter list." required: - "name" - "parameters" required: - "type" - "function" required: - "messages" - "variables" output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8CZGVVNVATK5KWB8FD1" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "evaluation_engine" default: "evaluation_engine" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.483Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.483Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.484Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.484Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.485Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.485Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.485Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.485Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.486Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.486Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.487Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.487Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.487Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.487Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.488Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.488Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.489Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.489Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.489Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.489Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.490Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.490Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.491Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.491Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.491Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.491Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.500Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.500Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.500Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.500Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.501Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.502Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.502Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.503Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.evaluation_engine" input: type: "object" properties: context: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8EGVPGZWXGCT0K13WX0" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "evaluator" default: "evaluator" evaluator_id: type: "string" evaluator_type: type: "string" extra_params: type: "object" additionalProperties: {} gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.540Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.540Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.541Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.541Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.542Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.542Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.542Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.542Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.543Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.543Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.544Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.544Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.544Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.544Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.545Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.545Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.546Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.546Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.546Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.546Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.547Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.547Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.548Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.548Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.548Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.548Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.549Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.550Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.550Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.550Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.551Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.551Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.552Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.552Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.evaluator" input: type: "object" properties: id: type: "string" evaluator_id: type: "string" evaluator_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" eval_type: type: "string" enum: - "function_eval" - "http_eval" - "json_schema" - "llm_eval" - "python_eval" - "ragas" - "typescript_eval" - "bedrock_eval" output_type: type: - "string" - "null" expected_value: type: - "string" - "null" display_name: type: "string" description: type: "string" input: type: "object" additionalProperties: {} required: - "id" - "evaluator_id" - "evaluator_type" - "display_name" - "description" output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8G33QQQCTTTQ6S623X4" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "cache_retrieval" default: "cache_retrieval" cache_config: oneOf: - type: "object" properties: type: type: "string" enum: - "exact" ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 required: - "type" description: "Configuration schema for exact-match cache. Entries are stored and retrieved based on exact input matches." - type: "object" properties: type: type: "string" enum: - "semantic" model_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" - "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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "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" is_private: type: - "boolean" - "null" default: false required: - "model" - "model_db_id" - "model_type" - "model_parameters" - "provider" description: "Configuration for the embedding model used to compute semantic similarity." ttl: type: "number" minimum: 1 maximum: 259200 default: 1800 description: "Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)." example: 3600 similarity_score_threshold: type: "number" default: 0 description: "Minimum similarity score (0 to 1) required for a cached entry to be considered a match." required: - "type" - "model_config" description: "Configuration schema for semantic cache. Entries are matched based on vector similarity rather than exact input matches." cache_status: type: "string" response_type: type: "string" enum: - "trace" - "block.llm_call" - "LlmCallBlock" - "block.evaluator" - "EvaluatorBlock" - "span.evaluator" - "span.retrieval" - "span.cache_retrieval" - "span.embedding" - "span.rerank" - "span.evaluation_engine" - "span.chat_completion" - "span.speech" - "span.completion" - "span.create_image" - "span.create_image_edit" - "span.create_image_variation" - "span.moderation" - "span.ocr" - "span.transcription" - "span.translation" - "span.deployment" - "span.chain" - "span.tool" - "span.generic" - "span.remote_config" - "span.playground" - "span.file_retrieval" - "span.prompt_snippet" - "span.spreadsheet" - "span.prompt_synthesize" - "span.query" - "span.agent" - "span.agent_execution" - "span.agent_thought" - "span.agent_execution_review" - "span.agent_execution_naming" - "span.agent_tool_execution" - "span.agent_action_review" - "span.responses" - "span.fallback_selected" - "span.retry" - "span.load_balancer" - "span.auto_router" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.586Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.586Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.587Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.587Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.587Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.587Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.588Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.588Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.589Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.589Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.589Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.589Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.590Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.590Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.591Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.591Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.591Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.591Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.592Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.592Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.593Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.593Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.594Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.594Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.594Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.594Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.595Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.595Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.596Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.596Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.597Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.597Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.598Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.605Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.cache_retrieval" input: type: "object" properties: 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" variables: type: "array" items: type: "object" properties: key: type: "string" value: {} is_pii: type: "boolean" default: false description: type: "string" required: - "key" tools: type: "array" items: 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. \n\n Omitting `parameters` defines a function with an empty parameter list." required: - "name" - "parameters" required: - "type" - "function" required: - "messages" - "variables" output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8HM1K3D5MX0MAQHYEZ7" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "retrieval" default: "retrieval" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.632Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.633Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.633Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.633Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.642Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.642Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.642Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.642Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.643Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.643Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.644Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.644Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.644Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.644Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.645Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.645Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.646Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.646Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.646Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.646Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.647Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.647Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.648Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.648Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.648Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.648Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.649Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.649Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.650Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.650Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.651Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.651Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.652Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.652Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.retrieval" input: type: "object" properties: query: type: "string" retrieval_config: anyOf: - type: "object" properties: type: type: "string" enum: - "vector_search" top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "Used to filter chunks that are most similar to the query" threshold: type: "number" maximum: 1 default: 0 description: "Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled." rerank_config: type: - "object" - "null" properties: enabled: type: "boolean" 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" - "slack" - "orq" description: "The provider to use for reranking" top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return by the reranking model" model: type: "string" description: "The name of the model to use" model_db_id: type: "string" description: "The ID of the model in the database" model_type: type: "string" enum: - "rerank" model_parameters: type: "object" properties: threshold: type: "number" description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" 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" required: - "type" - type: "object" properties: type: type: "string" enum: - "keyword_search" top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "Used to filter chunks that are most similar to the query" threshold: type: "number" maximum: 1 default: 0 description: "Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled." rerank_config: type: - "object" - "null" properties: enabled: type: "boolean" 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" - "slack" - "orq" description: "The provider to use for reranking" top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return by the reranking model" model: type: "string" description: "The name of the model to use" model_db_id: type: "string" description: "The ID of the model in the database" model_type: type: "string" enum: - "rerank" model_parameters: type: "object" properties: threshold: type: "number" description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" 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" required: - "type" - type: "object" properties: type: type: "string" enum: - "hybrid_search" top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "Used to filter chunks that are most similar to the query" threshold: type: "number" maximum: 1 default: 0 description: "Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled." rerank_config: type: - "object" - "null" properties: enabled: type: "boolean" 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" - "slack" - "orq" description: "The provider to use for reranking" top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return by the reranking model" model: type: "string" description: "The name of the model to use" model_db_id: type: "string" description: "The ID of the model in the database" model_type: type: "string" enum: - "rerank" model_parameters: type: "object" properties: threshold: type: "number" description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" 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" required: - "type" - type: "object" properties: top_k: type: "integer" minimum: 1 maximum: 100 default: 5 description: "Used to filter chunks that are most similar to the query" threshold: type: "number" maximum: 1 default: 0 description: "Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled." rerank_config: type: - "object" - "null" properties: enabled: type: "boolean" 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" - "slack" - "orq" description: "The provider to use for reranking" top_k: type: "integer" minimum: 1 maximum: 100 description: "The number of results to return by the reranking model" model: type: "string" description: "The name of the model to use" model_db_id: type: "string" description: "The ID of the model in the database" model_type: type: "string" enum: - "rerank" model_parameters: type: "object" properties: threshold: type: "number" description: "The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned" 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" output: type: "object" properties: id: type: "string" documents: type: "array" items: type: "object" properties: id: type: "string" description: "Unique identifier for the retrieval" text: type: "string" description: "Text content of the document" metadata: type: "object" properties: datasource_id: type: "string" description: "Unique identifier for the data source" chunk_id: type: "string" description: "Unique identifier for the chunk" file_name: type: "string" description: "Name of the uploaded file during the datasource creation." page_number: type: - "number" - "null" description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." file_type: type: "string" description: "Type of the uploaded file when the datasource was created." required: - "datasource_id" - "chunk_id" - "file_name" - "file_type" score: type: "number" description: "The score of the document" rerank_score: type: "number" description: "The rerank score of the document" embedding: type: "array" items: type: "number" chunk_metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "text" - "metadata" - "score" knowledge_id: type: "string" knowledge_key: type: "string" required: - "id" - "documents" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8K9W06J9Z0BJ5CJX6ZM" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "workflow_run" default: "workflow_run" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" leading_span: type: "object" properties: span_id: type: "string" span_type: type: "string" enum: - "trace" - "block.llm_call" - "LlmCallBlock" - "block.evaluator" - "EvaluatorBlock" - "span.evaluator" - "span.retrieval" - "span.cache_retrieval" - "span.embedding" - "span.rerank" - "span.evaluation_engine" - "span.chat_completion" - "span.speech" - "span.completion" - "span.create_image" - "span.create_image_edit" - "span.create_image_variation" - "span.moderation" - "span.ocr" - "span.transcription" - "span.translation" - "span.deployment" - "span.chain" - "span.tool" - "span.generic" - "span.remote_config" - "span.playground" - "span.file_retrieval" - "span.prompt_snippet" - "span.spreadsheet" - "span.prompt_synthesize" - "span.query" - "span.agent" - "span.agent_execution" - "span.agent_thought" - "span.agent_execution_review" - "span.agent_execution_naming" - "span.agent_tool_execution" - "span.agent_action_review" - "span.responses" - "span.fallback_selected" - "span.retry" - "span.load_balancer" - "span.auto_router" required: - "span_id" - "span_type" metadata: type: - "object" - "null" additionalProperties: {} agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.686Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.686Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.687Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.687Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.688Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.688Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.688Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.688Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.689Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.689Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.690Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.690Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.690Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.690Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.691Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.691Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.692Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.692Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.692Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.692Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.693Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.693Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.694Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.694Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.694Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.694Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.695Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.695Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.696Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.696Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.697Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.697Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.698Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.698Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} type: type: "string" enum: - "trace" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8MME8SP83PDB1XNNT9G" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "deployment" default: "deployment" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.731Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.731Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.732Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.732Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.732Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.732Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.733Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.733Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.734Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.734Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.734Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.734Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.735Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.735Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.742Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.742Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.743Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.743Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.744Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.745Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.745Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.745Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.746Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.746Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.747Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.747Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.748Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.748Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.748Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.748Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.749Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.750Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.750Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.751Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.deployment" input: $ref: "#/components/schemas/InvokeDeploymentRequest" output: type: "object" properties: choices: type: "array" items: type: "object" properties: index: type: "number" message: anyOf: - 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: 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" required: - "role" - "tool_calls" - 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: type: - "string" - "null" required: - "role" - "content" - type: "object" properties: 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: - "role" - "url" finish_reason: type: - "string" - "null" required: - "index" description: "A list of choices generated by the model" output_masking: type: "boolean" required: - "choices" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8P8MQFEWE3ZX006275M" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "spreadsheet" default: "spreadsheet" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.780Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.780Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.781Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.781Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.782Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.782Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.782Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.782Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.783Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.783Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.783Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.784Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.784Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.784Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.785Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.785Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.786Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.786Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.786Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.786Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.787Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.787Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.788Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.788Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.788Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.788Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.789Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.789Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.790Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.790Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.791Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.791Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.792Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.792Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.spreadsheet" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8QH62Z5AD0S8Z6N7EAP" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "playground" default: "playground" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.822Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.822Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.823Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.823Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.823Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.823Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.824Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.824Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.824Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.825Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.825Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.825Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.826Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.826Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.827Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.827Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.827Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.827Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.828Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.828Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.829Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.829Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.829Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.829Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.830Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.830Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.831Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.831Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.832Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.832Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.839Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.839Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.840Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.840Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.playground" input: type: "object" properties: inputs: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" - type: "array" items: {} prompt_config: type: "object" properties: stream: type: "boolean" model: type: "string" model_db_id: type: "string" model_type: type: "string" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "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: - "stream" - "model" - "model_db_id" - "model_type" - "model_parameters" - "provider" - "messages" tools: type: "array" items: 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. \n\n Omitting `parameters` defines a function with an empty parameter list." required: - "name" - "parameters" required: - "type" - "function" knowledge_bases: type: "array" items: type: "object" properties: 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: [] extra_params: type: "object" properties: product: type: "string" enum: - "remoteconfigs" - "deployments" - "experiments" - "playgrounds" - "spreadsheets" - "spreadsheet_run" - "llm_evaluator" - "knowledge" - "router" - "workflows" - "external_events" - "agents" - "memory-stores" - "generic" - "evaluators" - "otel" - "ai-chat" description: "The product to use for generation" related_entities: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "general_workflow_run" required: - "type" - type: "object" properties: type: type: "string" enum: - "remoteconfig" remote_config_id: type: "string" required: - "type" - "remote_config_id" - type: "object" properties: type: type: "string" enum: - "remoteconfig_variant" remote_config_variant_id: type: "string" required: - "type" - "remote_config_variant_id" - type: "object" properties: type: type: "string" enum: - "experiment_run" experiment_run_id: type: "string" required: - "type" - "experiment_run_id" - type: "object" properties: type: type: "string" enum: - "experiment" experiment_id: type: "string" required: - "type" - "experiment_id" - type: "object" properties: type: type: "string" enum: - "test_case_run" test_case_run_id: type: "string" required: - "type" - "test_case_run_id" - type: "object" properties: type: type: "string" enum: - "playground" playground_id: type: "string" required: - "type" - "playground_id" - type: "object" properties: type: type: "string" enum: - "playground_block" playground_block_id: type: "string" required: - "type" - "playground_block_id" - type: "object" properties: type: type: "string" enum: - "playground_completion" playground_completion_id: type: "string" required: - "type" - "playground_completion_id" - type: "object" properties: type: type: "string" enum: - "deployment_key" deployment_key: type: "string" required: - "type" - "deployment_key" - type: "object" properties: type: type: "string" enum: - "deployment" deployment_id: type: "string" required: - "type" - "deployment_id" - type: "object" properties: type: type: "string" enum: - "deployment_variant" deployment_variant_id: type: "string" deployment_variant_key: type: "string" deployment_variant_version: type: "string" required: - "type" - "deployment_variant_id" - type: "object" properties: type: type: "string" enum: - "deployment_completion" deployment_completion_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "deployment_completion_id" - type: "object" properties: type: type: "string" enum: - "account" account_id: type: "string" required: - "type" - "account_id" description: "Define the internal account of the system. Also sometimes called user (internal)" - type: "object" properties: type: type: "string" enum: - "api_key" api_key_id: type: "string" required: - "type" - "api_key_id" description: "Define the API key used for the request" - type: "object" properties: type: type: "string" enum: - "contact" contact_id: type: "string" required: - "type" - "contact_id" description: "Define the user set using the SDK" - type: "object" properties: type: type: "string" enum: - "experiment_test_case" test_case_id: type: "string" required: - "type" - "test_case_id" - type: "object" properties: type: type: "string" enum: - "spreadsheet" sheet_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "sheet_id" - type: "object" properties: type: type: "string" enum: - "spreadsheet_manifest" manifest_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "manifest_id" - type: "object" properties: type: type: "string" enum: - "spreadsheet_sheet_row" sheet_row_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "sheet_row_id" - type: "object" properties: type: type: "string" enum: - "spreadsheet_sheet_row_cell" cell_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "cell_id" - type: "object" properties: type: type: "string" enum: - "Dataset" dataset_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "dataset_id" - type: "object" properties: type: type: "string" enum: - "agent" agent_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "agent_id" - type: "object" properties: type: type: "string" enum: - "agent_execution" agent_execution_id: type: "string" format: "ulid" pattern: "^[0-9A-HJKMNP-TV-Z]{26}$" readOnly: true description: "The id of the resource" required: - "type" - "agent_execution_id" - type: "object" properties: type: type: "string" enum: - "knowledge" knowledge_id: type: "string" required: - "type" - "knowledge_id" project_id: type: "string" description: "The project id of the workspace" fallbacks: type: "array" items: type: "object" properties: stream: type: "boolean" model: type: "string" model_db_id: type: "string" model_type: type: "string" enum: - "chat" - "completion" - "embedding" - "image" - "tts" - "stt" - "rerank" - "ocr" - "moderation" - "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. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: 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: type: "string" enum: - "ephemeral" description: "Create a cache control breakpoint. 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:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults 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: type: "string" enum: - "low" - "medium" - "high" description: "Controls the verbosity of the model output." 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" - "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: - "stream" - "model" - "model_db_id" - "model_type" - "model_parameters" - "provider" - "messages" variant_info: type: "object" properties: deployment_id: anyOf: - type: "string" format: "uuid" - type: "string" format: "ulid" deployment_key: type: "string" deployment_variant_version: type: "string" deployment_variant_id: anyOf: - type: "string" format: "uuid" - type: "string" format: "ulid" deployment_variant_position: type: "number" is_default_matched: type: "boolean" required: - "deployment_id" - "deployment_key" - "deployment_variant_version" - "deployment_variant_id" - "deployment_variant_position" - "is_default_matched" required: - "product" - "related_entities" - "project_id" workspace_id: type: "string" engine: type: "string" enum: - "text" - "jinja" - "mustache" default: "text" required: - "inputs" - "prompt_config" - "extra_params" - "workspace_id" output: type: "array" items: type: "object" properties: index: type: "number" message: anyOf: - 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: 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" required: - "role" - "tool_calls" - 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: type: - "string" - "null" required: - "role" - "content" - type: "object" properties: 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: - "role" - "url" finish_reason: type: - "string" - "null" required: - "index" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE8SDCRX0S2GPPDPNCPAR" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "query" default: "query" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.882Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.883Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.883Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.883Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.884Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.884Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.885Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.885Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.885Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.885Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.886Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.886Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.886Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.887Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.887Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.887Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.888Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.888Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.889Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.889Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.889Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.889Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.890Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.890Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.891Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.891Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.892Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.892Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.893Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.893Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.894Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.896Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.897Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.898Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.query" input: type: "object" additionalProperties: {} output: type: "object" properties: documents: type: "array" items: type: "object" properties: id: type: "string" description: "Unique identifier for the retrieval" text: type: "string" description: "Text content of the document" metadata: type: "object" properties: datasource_id: type: "string" description: "Unique identifier for the data source" chunk_id: type: "string" description: "Unique identifier for the chunk" file_name: type: "string" description: "Name of the uploaded file during the datasource creation." page_number: type: - "number" - "null" description: "Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`." file_type: type: "string" description: "Type of the uploaded file when the datasource was created." required: - "datasource_id" - "chunk_id" - "file_name" - "file_type" score: type: "number" description: "The score of the document" rerank_score: type: "number" description: "The rerank score of the document" embedding: type: "array" items: type: "number" chunk_metadata: type: "object" additionalProperties: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "text" - "metadata" - "score" required: - "documents" required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8V1ZMNMESQ1E7GHF8FR" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent" default: "agent" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.934Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.934Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.935Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.935Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.935Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.936Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.936Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.936Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.937Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.937Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.937Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.938Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.938Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.938Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.939Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.939Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.946Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.946Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.946Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.946Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.947Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.947Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.948Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.948Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.949Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.949Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.950Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.950Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.950Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.950Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.951Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.952Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.952Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.953Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.agent" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8WBAN22JF9K0FEWPZJN" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_execution" default: "agent_execution" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.982Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.982Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.983Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.983Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.983Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.983Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.984Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.984Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.985Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.985Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.985Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.985Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.986Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.986Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.987Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.987Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.987Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.987Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.988Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.988Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.989Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.989Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.989Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.990Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.990Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.990Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.991Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.991Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.992Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.992Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.993Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.993Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.994Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:08.994Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.agent_execution" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8XVSTV534WPDNEHR3YG" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_thought" default: "agent_thought" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.023Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.023Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.024Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.024Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.024Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.025Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.025Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.025Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.026Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.026Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.026Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.026Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.027Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.027Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.028Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.028Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.028Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.029Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.029Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.029Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.030Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.030Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.031Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.031Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.031Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.031Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.032Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.033Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.033Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.033Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.034Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.034Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.041Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.041Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.agent_thought" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE8Z5BAFAF3NRG39F6Z88" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_action_review" default: "agent_action_review" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.069Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.069Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.070Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.070Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.070Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.070Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.077Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.077Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.078Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.078Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.079Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.079Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.079Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.080Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.080Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.080Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.081Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.081Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.082Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.082Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.082Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.082Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.083Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.083Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.084Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.084Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.085Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.085Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.085Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.085Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.086Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.087Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.087Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.088Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.agent_action_review" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE90V5RD3YZ7T7YS0FZ1D" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_execution_naming" default: "agent_execution_naming" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.120Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.120Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.121Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.121Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.121Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.121Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.122Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.122Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.123Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.123Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.123Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.123Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.124Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.124Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.125Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.125Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.126Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.126Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.126Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.126Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.127Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.127Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.128Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.128Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.128Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.128Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.129Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.129Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.130Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.130Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.131Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.131Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.132Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.132Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.agent_execution_naming" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE925KJ5FPRGGZTDE5XMA" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_tool_execution" default: "agent_tool_execution" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.161Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.161Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.162Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.162Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.163Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.163Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.164Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.164Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.164Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.164Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.165Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.165Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.166Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.166Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.166Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.166Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.167Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.167Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.168Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.168Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.169Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.169Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.169Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.169Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.176Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.176Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.177Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.177Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.177Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.178Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.178Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.179Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.179Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.180Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} type: type: "string" enum: - "span.tool" required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE93E9HM466NNYZP78CCT" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "agent_tool_execution" default: "agent_tool_execution" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.209Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.209Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.210Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.210Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.210Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.210Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.211Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.211Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.212Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.212Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.212Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.212Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.213Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.213Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.214Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.214Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.214Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.214Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.215Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.215Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.216Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.216Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.217Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.217Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.217Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.217Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.218Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.219Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.219Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.219Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.220Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.220Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.221Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.221Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} type: type: "string" enum: - "span.agent_tool_execution" required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE94YDDRCNS311PMDADCJ" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "responses" default: "responses" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.251Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.251Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.251Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.251Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.252Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.252Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.253Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.253Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.253Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.253Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.254Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.254Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.255Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.255Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.255Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.255Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.256Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.256Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.257Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.257Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.257Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.257Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.258Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.258Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.259Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.259Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.260Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.260Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.261Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.261Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.261Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.262Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.263Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.263Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.responses" input: type: "object" properties: model: type: "string" description: "ID of the model to use. You can use the List models API to see all of your available models." metadata: type: "object" additionalProperties: type: "string" description: "Developer-defined key-value pairs that will be included in response objects" temperature: type: - "number" - "null" minimum: 0 maximum: 2 description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." top_p: type: - "number" - "null" minimum: 0 maximum: 1 description: "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered." previous_response_id: type: - "string" - "null" description: "The ID of a previous response to continue the conversation from. The model will have access to the previous response context." instructions: type: - "string" - "null" description: "Developer-provided instructions that the model should follow. Overwrites the default system message." reasoning: type: - "object" - "null" properties: effort: type: "string" enum: - "none" - "minimal" - "low" - "medium" - "high" - "xhigh" description: "The effort level for reasoning" summary: type: - "string" - "null" enum: - "auto" - "concise" - "detailed" - null description: "The summary mode for reasoning output" description: "Configuration for reasoning models" thinking: oneOf: - $ref: "#/components/schemas/ThinkingConfigDisabledSchema" - $ref: "#/components/schemas/ThinkingConfigEnabledSchema" - $ref: "#/components/schemas/ThinkingConfigAdaptiveSchema" - type: "null" description: "Configuration for thinking mode. Use `adaptive` for models that support it (e.g. Claude Opus 4.6, Sonnet 4.6), or `enabled` with `budget_tokens` for manual control." max_output_tokens: type: - "integer" - "null" description: "The maximum number of tokens that can be generated in the response" text: type: - "object" - "null" properties: format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" description: "Plain text response format" required: - "type" - type: "object" properties: type: type: "string" enum: - "json_object" description: "Ensures the response is a valid JSON object" required: - "type" - type: "object" properties: type: type: "string" enum: - "json_schema" description: "Ensures the response matches a supplied JSON schema" name: type: "string" description: "The name of the response format. 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 response format is for, used by the model to determine how to respond in the format." schema: type: "object" additionalProperties: {} description: "The JSON schema to validate the response against" strict: type: "boolean" default: true description: "Whether to enable strict `schema` adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when `strict` is `true`" required: - "type" - "name" - "schema" required: - "format" input: anyOf: - type: "string" - type: "array" items: anyOf: - type: "object" properties: role: type: "string" enum: - "user" - "assistant" - "system" - "developer" description: "The role of the message author" content: anyOf: - type: "string" - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" description: "The type of input content" text: type: "string" description: "The text content" required: - "type" - "text" description: "A text input content part" - type: "object" properties: type: type: "string" enum: - "input_image" description: "The type of input content part" detail: type: "string" enum: - "high" - "low" - "auto" default: "auto" description: "Level of detail for image analysis" file_id: type: - "string" - "null" description: "File ID for the image" image_url: type: - "string" - "null" description: "URL of the image (can be http URL or data URL)" required: - "type" description: "An image input content part." - type: "object" properties: type: type: "string" enum: - "input_file" description: "The type of input content part" file_data: type: "string" description: "Base64 encoded file data" file_id: type: "string" description: "File ID from the Files API" filename: type: "string" description: "Name of the file" file_url: type: "string" description: "URL of the file to fetch" required: - "type" description: "A file input content part." description: "The content of the message, either a string or an array of content parts" required: - "role" - "content" description: "Represents a message in the conversation, with a role and content (string or rich content parts)." - type: "object" properties: type: type: "string" enum: - "function_call_output" description: "The type of input item" call_id: type: "string" description: "The ID of the function call this output is for" output: type: "string" description: "The output from the function call" required: - "type" - "call_id" - "output" description: "Represents the output of a function tool call, provided as input to the model." - type: "object" properties: type: type: "string" enum: - "function_call" description: "The type of input item" call_id: type: "string" description: "The ID of the function call" id: type: "string" description: "The unique identifier for this function call" name: type: "string" description: "The name of the function being called" arguments: type: "string" description: "The arguments to the function as a JSON string" status: type: "string" description: "The status of the function call" required: - "type" - "call_id" - "id" - "name" - "arguments" - "status" description: "Represents a function tool call, provided as input to the model." description: "The actual user input(s) for the model. Can be a simple string, or an array of structured input items (messages, tool outputs) representing a conversation history or complex input." include: type: - "array" - "null" items: type: "string" enum: - "code_interpreter_call.outputs" - "computer_call_output.output.image_url" - "file_search_call.results" - "message.input_image.image_url" - "message.output_text.logprobs" - "reasoning.encrypted_content" - "web_search_call.results" - "web_search_call.action.sources" description: "Specifies which (potentially large) fields to include in the response." parallel_tool_calls: type: - "boolean" - "null" description: "Whether to enable parallel function calling during tool use." store: type: - "boolean" - "null" description: "Whether to store this response for use in distillations or evals." service_tier: type: - "string" - "null" enum: - "auto" - "default" - "flex" - "scale" - "priority" - null description: "Specifies the latency tier to use for processing the request. Defaults to \"auto\"." tools: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "function" description: "The type of tool" name: type: "string" description: "The name of the function to be called" description: type: - "string" - "null" description: "A description of what the function does" parameters: type: - "object" - "null" additionalProperties: {} description: "The parameters the function accepts as a JSON Schema object" strict: type: - "boolean" - "null" default: true description: "Whether to enable strict schema adherence when generating function calls" required: - "type" - "name" description: "A function tool definition" - type: "object" properties: type: type: "string" enum: - "web_search_preview" description: "The type of tool" domains: type: "array" items: type: "string" description: "List of domains to restrict search to" search_context_size: type: "string" enum: - "low" - "medium" - "high" description: "Amount of context to retrieve for each search result" user_location: type: "object" properties: type: type: "string" enum: - "approximate" - "exact" description: "The type of location" city: type: - "string" - "null" description: "The city name" country: type: "string" description: "The country code" region: type: - "string" - "null" description: "The region/state" timezone: type: - "string" - "null" description: "The timezone" description: "User location for search localization" required: - "type" description: "Configuration for web search preview tool" - type: "object" properties: type: type: "string" enum: - "web_search" description: "The type of tool" search_context_size: type: "string" enum: - "low" - "medium" - "high" description: "Amount of context to retrieve for each search result" user_location: type: "object" properties: type: type: "string" enum: - "approximate" - "exact" description: "The type of location" city: type: - "string" - "null" description: "The city name" country: type: "string" description: "The country code" region: type: - "string" - "null" description: "The region/state" timezone: type: - "string" - "null" description: "The timezone" description: "User location for search localization" filters: type: - "object" - "null" properties: allowed_domains: type: - "array" - "null" items: type: "string" description: "List of allowed domains for search" description: "Filters for the web search" required: - "type" description: "Configuration for web search tool" - type: "object" properties: type: type: "string" enum: - "file_search" description: "The type of tool" vector_store_ids: type: "array" items: type: "string" description: "The vector stores to search" max_num_results: type: "integer" minimum: 1 maximum: 50 description: "Maximum number of results to return" filters: description: "Filters to apply to the search" ranking_options: type: "object" properties: ranker: type: "string" enum: - "auto" - "default_2024_08_21" description: "The ranking algorithm" score_threshold: type: "number" minimum: 0 maximum: 1 description: "Minimum relevance score" description: "Options for ranking search results" required: - "type" description: "Configuration for file search tool" description: "A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for." tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" description: "Controls which (if any) tool is called by the model. `none` means the model will not call any tool. `auto` means the model can pick between generating a message or calling a tool. `required` means the model must call a tool." - type: "object" properties: type: type: "string" enum: - "file_search" - "web_search_preview" - "web_search_preview_2025_03_11" - "web_search" - "computer_use_preview" - "computer_use" - "computer" - "code_interpreter" - "image_generation" required: - "type" - type: "object" properties: type: type: "string" enum: - "function" name: type: "string" required: - "type" - "name" - type: "object" properties: type: type: "string" enum: - "mcp" server_label: type: "string" name: type: - "string" - "null" required: - "type" - "server_label" description: "How the model should select which tool (or tools) to use when generating a response. Can be a string (`none`, `auto`, `required`) or an object to force a specific tool." stream: type: "boolean" enum: - false description: "If false, the entire response is returned in one JSON payload" required: - "model" - "input" - "stream" description: "Request to create a non-streaming response" output: type: "object" properties: id: type: "string" description: "The unique identifier for the response" object: type: "string" enum: - "response" description: "The object type, which is always \"response\"" created_at: type: "number" description: "The Unix timestamp (in seconds) of when the response was created" status: type: "string" enum: - "completed" - "failed" - "in_progress" - "cancelled" - "queued" - "incomplete" description: "The status of the response" error: type: - "object" - "null" properties: code: type: "string" description: "The error code" message: type: "string" description: "The error message" required: - "code" - "message" description: "The error that occurred, if any" incomplete_details: type: - "object" - "null" properties: reason: type: "string" enum: - "max_output_tokens" - "content_filter" description: "The reason the response is incomplete" required: - "reason" description: "Details about why the response is incomplete" model: type: "string" description: "The model used to generate the response" instructions: type: - "string" - "null" description: "The instructions provided for the response" output: type: "array" items: oneOf: - type: "object" properties: id: type: "string" description: "The unique identifier for this message" type: type: "string" enum: - "message" description: "The type of output item" role: type: "string" enum: - "assistant" description: "The role of the message author" status: type: "string" enum: - "in_progress" - "completed" - "incomplete" - "failed" description: "The status of the message" content: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "output_text" description: "The type of content part" text: type: "string" description: "The text content" annotations: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "url_citation" start_index: type: "number" description: "The start index of the citation in the text" end_index: type: "number" description: "The end index of the citation in the text" url: type: "string" description: "The URL being cited" title: type: "string" description: "The title of the cited resource" text: type: "string" description: "The text of the citation" required: - "type" - "start_index" - "end_index" - "url" - "title" description: "A citation to a URL" - type: "object" properties: type: type: "string" enum: - "file_citation" index: type: "number" description: "The index in the text where the citation appears" file_id: type: "string" description: "The ID of the file being cited" filename: type: "string" description: "The name of the file being cited" required: - "type" - "index" - "file_id" - "filename" description: "A citation to a file" description: "An annotation in the output text" default: [] description: "Annotations in the text such as citations" logprobs: type: - "array" - "null" items: {} description: "Log probabilities of the output tokens if requested" required: - "type" - "text" description: "Text output from the model" - type: "object" properties: type: type: "string" enum: - "refusal" description: "The type of content part" refusal: type: "string" description: "The refusal message" required: - "type" - "refusal" description: "A refusal content part from the model" default: [] description: "The content parts of the message" required: - "id" - "type" - "role" - "status" description: "An assistant message output" - type: "object" properties: id: type: "string" description: "The unique identifier for this output item" type: type: "string" enum: - "web_search_call" description: "The type of output item" status: type: "string" enum: - "in_progress" - "completed" - "incomplete" - "failed" description: "The status of the web search" action: type: "object" properties: type: type: "string" enum: - "search" - "open_page" - "find" description: "The type of web search action" query: type: "string" description: "The search query (for search action)" url: type: "string" description: "The URL opened (for open_page action)" pattern: type: "string" description: "The pattern to find (for find action)" sources: type: "array" items: type: "object" properties: url: type: "string" description: "The source URL" title: type: "string" description: "The source title" required: - "url" - "title" description: "Sources from the web search" required: - "type" description: "The action performed by the web search" required: - "id" - "type" - "status" description: "A web search tool call output" - type: "object" properties: id: type: "string" description: "The unique identifier for this output item" type: type: "string" enum: - "file_search_call" description: "The type of output item" status: type: "string" enum: - "in_progress" - "completed" - "incomplete" - "failed" description: "The status of the file search" queries: type: "array" items: type: "string" description: "The search queries used" results: description: "The file search results" required: - "id" - "type" - "status" description: "A file search tool call output" - type: "object" properties: id: type: "string" description: "The unique identifier for this output item" type: type: "string" enum: - "function_call" description: "The type of output item" call_id: type: "string" description: "The ID of the function call" name: type: "string" description: "The name of the function being called" arguments: type: "string" description: "The arguments to the function as a JSON string" status: type: "string" enum: - "in_progress" - "completed" - "incomplete" - "failed" description: "The status of the function call" required: - "id" - "type" - "call_id" - "name" - "arguments" - "status" description: "A function tool call output" - type: "object" properties: id: type: "string" description: "The unique identifier for this reasoning item" type: type: "string" enum: - "reasoning" description: "The type of output item" summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" description: "The type of summary part" text: type: "string" description: "The summary text" required: - "type" - "text" description: "A text summary of the reasoning" default: [] description: "Summary of the reasoning" encrypted_content: type: - "string" - "null" description: "Encrypted reasoning content" status: type: "string" enum: - "in_progress" - "completed" - "incomplete" - "failed" description: "The status of the reasoning item" required: - "id" - "type" description: "A reasoning output item from the model" description: "The list of output items generated by the model" output_text: type: - "string" - "null" description: "A convenience field with the concatenated text from all text content parts" usage: type: "object" properties: input_tokens: type: "number" description: "Number of tokens in the input" output_tokens: type: "number" description: "Number of tokens in the generated output" total_tokens: type: "number" description: "Total number of tokens used in the request (input + output)" input_tokens_details: type: "object" properties: cached_tokens: type: "integer" description: "Number of tokens from cache" description: "Breakdown of input token usage" output_tokens_details: type: "object" properties: reasoning_tokens: type: "integer" description: "Number of tokens used for reasoning (o3 models)" accepted_prediction_tokens: type: "integer" description: "Number of tokens generated by automatic prediction that were accepted" rejected_prediction_tokens: type: "integer" description: "Number of tokens generated by automatic prediction that were rejected" description: "Breakdown of output token usage" input_cost: type: "number" description: "Cost (USD) of input tokens. Present when billing was computed for this response." output_cost: type: "number" description: "Cost (USD) of output tokens. Present when billing was computed for this response." total_cost: type: "number" description: "Total cost (USD) of the response. Present when billing was computed for this response." description: "Usage statistics for the response" temperature: type: - "number" - "null" top_p: type: - "number" - "null" max_output_tokens: type: - "integer" - "null" parallel_tool_calls: type: "boolean" previous_response_id: type: - "string" - "null" metadata: type: "object" additionalProperties: type: "string" tool_choice: anyOf: - type: "string" enum: - "none" - "auto" - "required" - type: "object" properties: type: type: "string" enum: - "function" function: type: "object" properties: name: type: "string" required: - "name" required: - "type" - "function" description: "Controls which (if any) tool is called by the model" tools: type: "array" items: oneOf: - type: "object" properties: type: type: "string" enum: - "function" description: "The type of tool" name: type: "string" description: "The name of the function to be called" description: type: - "string" - "null" description: "A description of what the function does" parameters: type: - "object" - "null" additionalProperties: {} description: "The parameters the function accepts as a JSON Schema object" strict: type: - "boolean" - "null" default: true description: "Whether to enable strict schema adherence when generating function calls" required: - "type" - "name" description: "A function tool definition" - type: "object" properties: type: type: "string" enum: - "web_search_preview" description: "The type of tool" domains: type: "array" items: type: "string" description: "List of domains to restrict search to" search_context_size: type: "string" enum: - "low" - "medium" - "high" description: "Amount of context to retrieve for each search result" user_location: type: "object" properties: type: type: "string" enum: - "approximate" - "exact" description: "The type of location" city: type: - "string" - "null" description: "The city name" country: type: "string" description: "The country code" region: type: - "string" - "null" description: "The region/state" timezone: type: - "string" - "null" description: "The timezone" description: "User location for search localization" required: - "type" description: "Configuration for web search preview tool" - type: "object" properties: type: type: "string" enum: - "web_search" description: "The type of tool" search_context_size: type: "string" enum: - "low" - "medium" - "high" description: "Amount of context to retrieve for each search result" user_location: type: "object" properties: type: type: "string" enum: - "approximate" - "exact" description: "The type of location" city: type: - "string" - "null" description: "The city name" country: type: "string" description: "The country code" region: type: - "string" - "null" description: "The region/state" timezone: type: - "string" - "null" description: "The timezone" description: "User location for search localization" filters: type: - "object" - "null" properties: allowed_domains: type: - "array" - "null" items: type: "string" description: "List of allowed domains for search" description: "Filters for the web search" required: - "type" description: "Configuration for web search tool" - type: "object" properties: type: type: "string" enum: - "file_search" description: "The type of tool" vector_store_ids: type: "array" items: type: "string" description: "The vector stores to search" max_num_results: type: "integer" minimum: 1 maximum: 50 description: "Maximum number of results to return" filters: description: "Filters to apply to the search" ranking_options: type: "object" properties: ranker: type: "string" enum: - "auto" - "default_2024_08_21" description: "The ranking algorithm" score_threshold: type: "number" minimum: 0 maximum: 1 description: "Minimum relevance score" description: "Options for ranking search results" required: - "type" description: "Configuration for file search tool" reasoning: type: - "object" - "null" properties: effort: type: - "string" - "null" summary: type: - "string" - "null" store: type: "boolean" text: type: "object" properties: format: oneOf: - type: "object" properties: type: type: "string" enum: - "text" description: "Plain text response format" required: - "type" - type: "object" properties: type: type: "string" enum: - "json_object" description: "Ensures the response is a valid JSON object" required: - "type" - type: "object" properties: type: type: "string" enum: - "json_schema" description: "Ensures the response matches a supplied JSON schema" name: type: "string" description: "The name of the response format. 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 response format is for, used by the model to determine how to respond in the format." schema: type: "object" additionalProperties: {} description: "The JSON schema to validate the response against" strict: type: "boolean" default: true description: "Whether to enable strict `schema` adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when `strict` is `true`" required: - "type" - "name" - "schema" required: - "format" truncation: type: - "string" - "null" enum: - "auto" - "disabled" - null description: "Controls how the model handles inputs longer than the maximum token length" user: type: - "string" - "null" description: "A unique identifier representing your end-user" service_tier: type: - "string" - "null" enum: - "auto" - "default" - "flex" - "scale" - "priority" - null description: "The service tier used for processing the request" background: type: - "boolean" - "null" description: "Whether the response was processed in the background" top_logprobs: type: - "integer" - "null" minimum: 0 maximum: 20 description: "The number of top log probabilities to return for each output token" logprobs: type: - "boolean" - "null" description: "Whether to return log probabilities of the output tokens" required: - "id" - "object" - "created_at" - "status" - "incomplete_details" - "model" - "output" - "parallel_tool_calls" description: "Represents the completed model response returned when `stream` is false" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE96XGFKKP6PA3D6YYTXT" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "fallback_selected" default: "fallback_selected" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.313Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.313Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.314Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.314Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.315Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.315Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.316Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.316Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.316Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.316Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.317Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.317Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.318Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.318Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.318Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.318Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.319Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.319Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.320Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.320Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.320Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.320Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.321Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.321Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.322Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.322Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.323Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.323Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.323Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.324Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.324Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.325Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.325Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.326Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.fallback_selected" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE987Z0KJRQ4QKFMT0XRC" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "retry" default: "retry" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.356Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.356Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.357Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.357Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.358Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.358Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.359Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.359Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.359Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.359Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.360Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.360Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.361Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.361Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.361Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.361Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.362Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.362Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.363Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.363Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.364Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.364Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.364Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.364Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.365Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.365Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.366Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.366Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.367Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.367Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.367Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.374Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.375Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.375Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.retry" input: type: "object" additionalProperties: {} output: type: "object" additionalProperties: {} required: - "trace_id" - "attributes" - "type" - type: "object" properties: _id: type: "string" default: "01KZEAE99KQDSHBYN21T4ZXZS2" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "load_balancer" default: "load_balancer" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.402Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.402Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.404Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.404Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.412Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.413Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.414Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.414Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.415Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.415Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.416Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.417Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.418Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.418Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.420Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.420Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.421Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.421Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.422Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.422Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.422Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.423Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.423Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.423Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.424Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.424Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.425Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.425Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.426Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.426Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.426Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.427Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.428Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.428Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.load_balancer" input: type: "object" properties: original_model: type: "string" config: oneOf: - type: "object" properties: type: type: "string" enum: - "weight_based" models: type: "array" items: type: "object" properties: model: type: "string" description: "Model identifier for load balancing" example: "openai/gpt-4o" weight: type: "number" minimum: 0.001 maximum: 1 default: 0.5 description: "Weight assigned to this model for load balancing" example: 0.7 required: - "model" required: - "type" - "models" required: - "original_model" - "config" output: type: "object" properties: selected_model: type: "string" selected_weight: type: "number" minimum: 0 maximum: 1 required: - "selected_model" - "selected_weight" required: - "trace_id" - "attributes" - "type" - "input" - "output" - type: "object" properties: _id: type: "string" default: "01KZEAE9BDJSRBXBSPEQ6H8ZWD" name: type: "string" description: "Name of the trace or block" trace_id: type: "string" description: "Unique trace ID" duration: type: "number" description: "Total time elapsed between the trace start and end timestamp" total_tokens: type: "number" description: "Total number of tokens used by the trace" total_cost: type: "number" description: "Total cost of the trace" billable: type: "boolean" description: "Whether the trace is billable" session_id: type: - "string" - "null" description: "Unique ID to relate multiple traces together" context: type: "object" properties: trace_id: type: "string" description: "Unique identifier for the trace" span_id: type: "string" description: "Unique identifier for the span within the trace" required: - "trace_id" - "span_id" description: "Context information for the trace" parent_id: type: - "string" - "null" description: "Parent trace ID, if applicable" start_time: type: "string" description: "ISO timestamp indicating when the trace started" end_time: type: "string" description: "ISO timestamp indicating when the trace ended" events: type: "array" items: type: "object" additionalProperties: {} description: "List of events associated with this trace" attributes: type: "object" properties: type: type: "string" enum: - "auto_router" default: "auto_router" gen_ai: type: "object" properties: operation: type: "object" properties: name: type: "string" request: type: "object" properties: model: type: "string" frequency_penalty: type: "number" max_tokens: type: "number" presence_penalty: type: "number" seed: type: "number" temperature: type: - "number" - "null" top_p: type: - "number" - "null" top_k: type: - "number" - "null" stream: type: "boolean" default: false choice: type: "object" properties: count: type: "number" description: "Number of candidate completions requested" stop_sequences: type: "array" items: type: "string" description: "Array of sequences that stop token generation" encoding_formats: type: "array" items: type: "string" description: "Encoding formats for embeddings requests" response_format: description: "Response format configuration (e.g., json_object, json_schema, text)" system: type: "string" system_instructions: type: "string" description: "System message/instructions to model" response: type: "object" properties: finish_reasons: type: "array" items: type: - "string" - "null" description: "The reasons for the LLM call failing" id: type: "string" description: "The ID of the LLM response" model: type: "string" description: "The model used in the LLM response" description: "Details of the LLM response" usage: type: "object" properties: input_tokens: type: - "number" - "null" minimum: 0 output_tokens: type: - "number" - "null" minimum: 0 prompt_tokens: type: - "number" - "null" minimum: 0 completion_tokens: type: - "number" - "null" minimum: 0 total_tokens: type: - "number" - "null" minimum: 0 prompt_tokens_details: type: - "object" - "null" properties: cached_tokens: type: - "number" - "null" minimum: 0 cache_creation_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 completion_tokens_details: type: - "object" - "null" properties: reasoning_tokens: type: - "number" - "null" minimum: 0 audio_tokens: type: - "number" - "null" minimum: 0 accepted_prediction_tokens: type: - "number" - "null" minimum: 0 rejected_prediction_tokens: type: - "number" - "null" minimum: 0 agent: type: "object" properties: id: type: "string" description: "Unique identifier of AI agent" name: type: "string" description: "Human-readable agent name" description: type: "string" description: "Free-form agent description" source: type: "string" enum: - "internal" - "external" - "experiment" description: "Source of the agent manifest" conversation: type: "object" properties: id: type: "string" description: "Unique identifier for conversation/thread" tool: type: "object" properties: name: type: "string" description: "Tool name" call: type: "object" properties: id: type: "string" description: "Tool call identifier" arguments: description: "Arguments passed to the tool" result: description: "Result returned by the tool" description: type: "string" description: "Tool description" type: type: "string" enum: - "function" - "extension" - "datastore" description: "Tool type enum" definitions: description: "Tool/function definitions provided to the model" data_source: type: "object" properties: id: type: "string" description: "Data source identifier" input: type: "object" properties: messages: type: "array" items: {} description: "Chat history provided as input" prompt: type: "string" description: "Prompt text for Completion and Image models" additionalProperties: {} output: type: "object" properties: messages: type: "array" items: {} description: "Messages returned by model" type: type: "string" enum: - "text" - "json" - "image" - "speech" description: "Output type enum" completion: type: "string" description: "Completion text for Completion models" additionalProperties: {} provider: type: "object" properties: name: type: "string" enum: - "openai" - "azure.ai.openai" - "azure.ai.inference" - "gcp.gemini" - "gcp.gen_ai" - "gcp.vertex_ai" - "aws.bedrock" - "anthropic" - "cohere" - "mistral_ai" - "perplexity" - "groq" - "deepseek" - "x_ai" - "ibm.watsonx.ai" description: "Standardized provider names" token: type: "object" properties: type: type: "string" enum: - "input" - "output" description: "Token type enum" embeddings: type: "object" properties: dimension: type: "object" properties: count: type: "number" description: "Number of dimensions in the embedding vector" evaluation: type: "object" properties: name: type: "string" description: "Name of the evaluation" score: type: "object" properties: value: type: "number" description: "Numeric evaluation score" label: type: "string" description: "Label/category for the evaluation score" explanation: type: "string" description: "Explanation or reasoning for the evaluation result" passed: type: "boolean" description: "Whether the evaluation passed" agent: type: "object" properties: version: type: "string" environment: type: "string" iterations: type: "object" properties: count: type: "integer" minimum: 0 orq: type: "object" properties: related_entities: type: "object" additionalProperties: type: "object" additionalProperties: type: "boolean" description: "Related entities associated with the LLM call" workspace_id: type: "string" description: "The ID of the workspace" project_id: type: - "string" - "null" description: "The project ID inside the workspace" contact_id: type: - "string" - "null" description: "The ID of the contact" identity_id: type: - "string" - "null" description: "The ID of the identity" api_key_id: type: - "string" - "null" description: "The ID of the API key used for the request" thread_id: type: - "string" - "null" description: "The unique identifier for the thread" tags: type: - "array" - "null" items: type: "string" description: "Request-level tags used for trace/reporting attribution" product: type: "string" description: "The product that the LLM call belongs to" billing: type: "object" properties: total_cost: type: - "number" - "null" minimum: 0 input_cost: type: - "number" - "null" minimum: 0 output_cost: type: - "number" - "null" minimum: 0 cache_read_cost: type: - "number" - "null" minimum: 0 cache_write_cost: type: - "number" - "null" minimum: 0 audio_input_cost: type: - "number" - "null" minimum: 0 audio_output_cost: type: - "number" - "null" minimum: 0 reasoning_cost: type: - "number" - "null" minimum: 0 web_search_cost: type: - "number" - "null" minimum: 0 pricing_tier: type: - "string" - "null" threshold_exceeded: type: - "boolean" - "null" billable: type: - "boolean" - "null" default: true integration_id: type: - "string" - "null" default: "orq" latency: type: "number" description: "Total latency" time_to_first_token: type: "number" description: "Time in milliseconds to first token" costs: type: "number" description: "Total cost of the whole flow" object_name: type: - "string" - "null" description: "The name of the object" variables: type: "object" additionalProperties: {} context: type: "object" additionalProperties: {} evaluations: type: "array" items: anyOf: - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.458Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.458Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "completed" value: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.459Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.459Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.459Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.460Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "bert_score" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.460Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.460Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "completed" value: type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.461Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.461Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.461Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.462Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "boolean" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.462Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.462Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.463Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.463Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.464Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.464Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "http_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.464Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.464Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "completed" value: anyOf: - type: "string" - type: "number" - type: "boolean" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.465Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.465Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.466Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.466Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "llm_evaluator" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.466Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.466Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "completed" value: type: "object" properties: rouge_1: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_2: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" rouge_l: type: "object" properties: f1: type: "number" precision: type: "number" recall: type: "number" required: - "f1" - "precision" - "recall" required: - "rouge_1" - "rouge_2" - "rouge_l" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.467Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.467Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "pending" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the evaluation" evaluation_type: type: "string" enum: - "evaluator" description: "The type of evaluation" evaluator_id: type: "string" description: "The unique identifier of the evaluator" display_name: type: "string" description: "Display name override set when the evaluation is produced from an experiment run" evaluator_config_type: type: "string" enum: - "input_evaluator" - "output_evaluator" - "input_guardrail" - "output_guardrail" description: "Whether the evaluator is used for input or output, and if is guardrail" passed: type: "boolean" default: true description: "Whether the guardrail has passed" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. For workflow evals: { kind: llm | code, actor_id: eval span id }." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value, from the evaluator's configured output type." explanation: type: "string" description: "Optional free-text explanation of the value" started_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.468Z" description: "The date and time the evaluation started" finished_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.468Z" description: "The date and time the evaluation finished" type: type: "string" enum: - "rouge_n" status: type: "string" enum: - "failed" error_code: type: "number" default: 500 error_message: type: "string" default: "Unknown error" required: - "id" - "evaluation_type" - "evaluator_id" - "evaluator_config_type" - "type" - "status" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.469Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string" value: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.469Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "number" value: type: "number" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.470Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "boolean" value: type: "boolean" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "value" - type: "object" properties: id: type: "string" description: "The unique identifier of the human evaluation" evaluation_type: type: "string" enum: - "human_review" description: "The type of evaluation" human_review_id: type: "string" description: "The unique identifier of the human review. Omitted on corrections, which inherit the parent evaluator output schema." source: type: "string" enum: - "orq" - "external" default: "orq" annotator: type: "object" properties: kind: type: "string" enum: - "llm" - "code" - "human" - "automation" description: "The kind of annotator that produced the evaluation" actor_id: type: "string" description: "Who/what produced this annotation. User/contact id for human, evaluator eval span id for llm/code, automation rule id for automation." required: - "kind" - "actor_id" description: "The annotator that produced this evaluation. Optional during the dual-write deprecation window." output_schema: type: "string" enum: - "boolean" - "number" - "categorical" - "string" description: "The expected shape of the value. Derived from the human review type, or inherited from the parent annotation for corrections." parent_annotation_id: type: "string" description: "When present, references the id of the annotation this entry corrects. Presence of this field marks the entry as a correction." explanation: type: "string" description: "Optional free-text explanation of the value" reviewed_by_id: type: "string" deprecated: true description: "Deprecated: use annotator.actor_id. The unique identifier of the user who reviewed the item." reviewed_at: type: "string" format: "date-time" default: "2026-08-07T14:36:09.471Z" deprecated: true description: "Deprecated. The date and time the item was reviewed" type: type: "string" enum: - "string_array" values: type: "array" items: type: "string" required: - "id" - "evaluation_type" - "reviewed_by_id" - "type" - "values" description: "Evaluations associated with the span" duration: type: "number" description: "The duration of the operation in milliseconds" trace: type: "object" properties: framework: type: "object" properties: name: type: "string" minLength: 1 description: "Framework or platform name" version: type: "string" minLength: 1 description: "Framework version" required: - "name" description: "Framework or platform that generated the trace" graph: type: "object" properties: nodes: type: "array" items: type: "object" properties: id: type: "string" type: type: "string" span_ids: type: "array" items: type: "string" required: - "id" - "type" - "span_ids" edges: type: "array" items: type: "object" properties: source: type: "string" target: type: "string" required: - "source" - "target" required: - "nodes" - "edges" description: "Agent state-machine graph ({ nodes, edges }) attached to the root trace span. Present for LangGraph traces." description: "Trace-specific metadata" internal: type: "boolean" description: "An optional flag to indicate if the event is internal" masking: type: "object" properties: input: type: "boolean" description: "Whether input content masking was applied" output: type: "boolean" description: "Whether output content masking was applied" system: type: "boolean" description: "Whether system content masking was applied" description: "Masking state applied to span input, system, or output" settings: type: "object" properties: engine: type: "string" enum: - "text" - "jinja" - "mustache" description: "The template engine used for rendering prompts" description: "Deployment settings" description: "Orquesta-related attributes" otel: type: "object" properties: status_code: type: "string" enum: - "OK" - "ERROR" default: "OK" status_description: type: "string" otlp: type: "object" properties: status: type: "object" properties: message: type: "string" http: type: "object" properties: response: type: "object" properties: status_code: type: "number" required: - "status_code" required: - "response" openresponses: type: "object" properties: input: type: "array" items: anyOf: - type: "object" properties: type: anyOf: - type: "string" enum: - "item_reference" - type: "null" id: type: "string" description: "The ID of the item to reference." required: - "id" description: "An internal identifier for an item to reference." - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "reasoning" default: "reasoning" description: "The item type. Always `reasoning`." summary: type: "array" items: type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The content type. Always `summary_text`." text: type: "string" maxLength: 10485760 description: "The reasoning summary text." required: - "text" description: "Reasoning summary content associated with this item." encrypted_content: anyOf: - type: "string" - type: "null" required: - "summary" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "user" default: "user" description: "The message role. Always `user`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "system" default: "system" description: "The message role. Always `system`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "developer" default: "developer" description: "The message role. Always `developer`." content: anyOf: - type: "array" items: type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" type: type: "string" enum: - "message" default: "message" description: "The item type. Always `message`." role: type: "string" enum: - "assistant" default: "assistant" description: "The role of the message author. Always `assistant`." content: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The content type. Always `output_text`." text: type: "string" maxLength: 10485760 description: "The text content." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The citation type. Always `url_citation`." start_index: type: "integer" minimum: 0 description: "The index of the first character of the citation in the message." end_index: type: "integer" minimum: 0 description: "The index of the last character of the citation in the message." url: type: "string" description: "The URL of the cited resource." title: type: "string" description: "The title of the cited resource." required: - "start_index" - "end_index" - "url" - "title" description: "Citations associated with the text content." required: - "text" - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The content type. Always `refusal`." refusal: type: "string" maxLength: 10485760 description: "The refusal text." required: - "refusal" description: "A piece of assistant message content, such as text or a refusal." - type: "string" description: "The message content, as an array of content parts." status: anyOf: - type: "string" - type: "null" required: - "content" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call" default: "function_call" description: "The item type. Always `function_call`." name: type: "string" minLength: 1 maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" description: "The name of the function to call." arguments: type: "string" description: "The function arguments as a JSON string." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "name" - "arguments" - type: "object" properties: id: anyOf: - type: "string" - type: "null" call_id: type: "string" minLength: 1 maxLength: 64 description: "The unique ID of the function tool call generated by the model." type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" maxLength: 10485760 description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: anyOf: - allOf: - type: "string" enum: - "low" - "high" - "auto" - {} - type: "null" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)" - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: anyOf: - type: "string" - type: "null" file_data: anyOf: - type: "string" - type: "null" file_url: anyOf: - type: "string" - type: "null" description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A piece of message content, such as text, an image, or a file." - type: "string" description: "Text, image, or file output of the function tool call." status: anyOf: - allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} - type: "null" required: - "call_id" - "output" description: "The output of a function tool call." output: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "message" default: "message" description: "The type of the message. Always set to `message`." id: type: "string" description: "The unique ID of the message." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} role: allOf: - type: "string" enum: - "user" - "assistant" - "system" - "developer" - {} content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." - type: "object" properties: type: type: "string" enum: - "input_video" description: "The type of the input content. Always `input_video`." video_url: type: "string" description: "A base64 or remote url that resolves to a video file." required: - "type" - "video_url" description: "A content block representing a video input to the model." description: "A content part that makes up an input or output item." description: "The content of the message" required: - "id" - "status" - "role" - "content" description: "A message to or from the model." - type: "object" properties: type: type: "string" enum: - "function_call" default: "function_call" description: "The type of the item. Always `function_call`." id: type: "string" description: "The unique ID of the function call item." call_id: type: "string" description: "The unique ID of the function tool call that was generated." name: type: "string" description: "The name of the function that was called." arguments: type: "string" description: "The arguments JSON string that was generated." status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "name" - "arguments" - "status" description: "A function tool call that was generated by the model." - type: "object" properties: type: type: "string" enum: - "function_call_output" default: "function_call_output" description: "The type of the function tool call output. Always `function_call_output`." id: type: "string" description: "The unique ID of the function tool call output. Populated when this item is returned via API." call_id: type: "string" description: "The unique ID of the function tool call generated by the model." output: anyOf: - type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." - type: "string" status: allOf: - type: "string" enum: - "in_progress" - "completed" - "incomplete" description: "Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used." - {} created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "call_id" - "output" - "status" description: "A function tool call output that was returned by the tool." - type: "object" properties: type: type: "string" enum: - "reasoning" default: "reasoning" description: "The type of the item. Always `reasoning`." id: type: "string" description: "The unique ID of the reasoning item." content: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning content that was generated." summary: type: "array" items: anyOf: - type: "object" properties: type: type: "string" enum: - "input_text" default: "input_text" description: "The type of the input item. Always `input_text`." text: type: "string" description: "The text input to the model." required: - "text" description: "A text input to the model." - type: "object" properties: type: type: "string" enum: - "output_text" default: "output_text" description: "The type of the output text. Always `output_text`." text: type: "string" description: "The text output from the model." annotations: type: "array" items: type: "object" properties: type: type: "string" enum: - "url_citation" default: "url_citation" description: "The type of the URL citation. Always `url_citation`." url: type: "string" description: "The URL of the web resource." start_index: type: "integer" description: "The index of the first character of the URL citation in the message." end_index: type: "integer" description: "The index of the last character of the URL citation in the message." title: type: "string" description: "The title of the web resource." required: - "url" - "start_index" - "end_index" - "title" description: "An annotation that applies to a span of output text." description: "The annotations of the text output." logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" top_logprobs: type: "array" items: type: "object" properties: token: type: "string" logprob: type: "number" bytes: type: "array" items: type: "integer" required: - "token" - "logprob" - "bytes" description: "The top log probability of a token." required: - "token" - "logprob" - "bytes" - "top_logprobs" description: "The log probability of a token." required: - "text" - "annotations" - "logprobs" description: "A text output from the model." - type: "object" properties: type: type: "string" enum: - "text" default: "text" text: type: "string" required: - "text" description: "A text content." - type: "object" properties: type: type: "string" enum: - "summary_text" default: "summary_text" description: "The type of the object. Always `summary_text`." text: type: "string" description: "A summary of the reasoning output from the model so far." required: - "text" description: "A summary text from the model." - type: "object" properties: type: type: "string" enum: - "reasoning_text" default: "reasoning_text" description: "The type of the reasoning text. Always `reasoning_text`." text: type: "string" description: "The reasoning text from the model." required: - "text" description: "Reasoning text from the model." - type: "object" properties: type: type: "string" enum: - "refusal" default: "refusal" description: "The type of the refusal. Always `refusal`." refusal: type: "string" description: "The refusal explanation from the model." required: - "refusal" description: "A refusal from the model." - type: "object" properties: type: type: "string" enum: - "input_image" default: "input_image" description: "The type of the input item. Always `input_image`." image_url: anyOf: - type: "string" - type: "null" detail: allOf: - type: "string" enum: - "low" - "high" - "auto" - {} required: - "image_url" - "detail" description: "An image input to the model. Learn about [image inputs](/docs/guides/vision)." - type: "object" properties: type: type: "string" enum: - "input_file" default: "input_file" description: "The type of the input item. Always `input_file`." filename: type: "string" description: "The name of the file to be sent to the model." file_url: type: "string" description: "The URL of the file to be sent to the model." description: "A file input to the model." description: "A content part that makes up an input or output item." description: "The reasoning summary content that was generated." encrypted_content: type: "string" description: "The encrypted reasoning content that was generated." signature: type: "string" description: "The signature of the reasoning content that was generated." created_by: type: "string" description: "The identifier of the actor that created the item." required: - "id" - "summary" description: "A reasoning item that was generated by the model." - allOf: - type: "object" properties: id: type: "string" type: type: "string" status: type: "string" result: {} required: - "id" - "type" - "status" - {} description: "An item representing a message, tool call, tool output, reasoning, or other response element." object: type: "string" created_at: type: "number" status: type: "string" completed_at: type: "string" incomplete_details: type: "string" error: type: "string" previous_response_id: type: "string" instructions: type: "string" truncation: type: "string" enum: - "auto" - "disabled" service_tier: type: "string" enum: - "auto" - "default" - "flex" - "priority" safety_identifier: type: "string" prompt_cache_key: type: "string" user: type: "string" temperature: type: "number" top_p: type: "number" presence_penalty: type: "number" frequency_penalty: type: "number" parallel_tool_calls: type: "boolean" stream: type: "boolean" background: type: "boolean" store: type: "boolean" top_logprobs: type: "number" max_output_tokens: type: "number" max_tool_calls: type: "number" tools: type: "array" items: type: "object" properties: type: type: "string" enum: - "function" default: "function" description: "The type of the function tool. Always `function`." name: type: "string" description: "The name of the function to call." description: anyOf: - type: "string" - type: "null" parameters: anyOf: - type: "object" properties: {} additionalProperties: {} - type: "null" strict: anyOf: - type: "boolean" - type: "null" required: - "name" - "description" - "parameters" - "strict" description: "A tool that can be used to generate a response." tools_count: type: "number" tool_choice: type: "string" metadata: type: "object" additionalProperties: {} text: type: "string" stream_options: type: "string" reasoning: type: "string" include: type: "string" include_count: type: "number" additionalProperties: {} metadata: type: - "object" - "null" additionalProperties: {} type: type: "string" enum: - "span.auto_router" input: type: "object" properties: strong_model: type: "string" economical_model: type: "string" profile: type: "string" required: - "strong_model" - "economical_model" output: type: "object" properties: selected_model: type: "string" strong_preference: type: "number" required: - "selected_model" required: - "trace_id" - "attributes" - "type" - "input" - "output" x-code-samples: - lang: "curl" label: "Core - Retrieve a queue item" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/annotation-queues/01HXXXXXXXXXXXXXXXXXXXXXXX/items/item_01' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve a queue item" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nitem = client.annotation_queues.retrieve_item(\n annotation_queue_id=\"01HXXXXXXXXXXXXXXXXXXXXXXX\",\n item_id=\"item_01\",\n)\n\nprint(item.span_id)\n" - lang: "typescript" label: "Node.js - Retrieve a queue item" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\n\nconst item = await client.annotationQueues.retrieveItem({\n annotationQueueId: '01HXXXXXXXXXXXXXXXXXXXXXXX',\n itemId: 'item_01',\n});\n\nconsole.log(item.spanId);\n" security: - ApiKey: [] /v2/pii/detect: post: tags: [] summary: "Detect PII" description: "Reports whether the supplied text contains personally identifiable information, optionally with a per-type entity breakdown." operationId: "PIIDetect" requestBody: content: application/json: schema: $ref: "#/components/schemas/DetectRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DetectResponse" x-speakeasy-group: "pii" x-speakeasy-name-override: "detect" security: - ApiKey: [] /v2/pii/redact: post: tags: [] summary: "Redact PII" description: "Replaces detected PII with placeholders and returns the reverse mapping needed to restore the original text." operationId: "PIIRedact" requestBody: content: application/json: schema: $ref: "#/components/schemas/RedactRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/RedactResponse" x-speakeasy-group: "pii" x-speakeasy-name-override: "redact" security: - ApiKey: [] /v2/pii/restore: post: tags: [] summary: "Restore redacted text" description: "Reverses a redaction, substituting placeholders back to their original values using the mapping returned by Redact." operationId: "PIIRestore" requestBody: content: application/json: schema: $ref: "#/components/schemas/RestoreRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/RestoreResponse" x-speakeasy-group: "pii" x-speakeasy-name-override: "restore" security: - ApiKey: [] /v2/guardrail-rules: get: description: "Returns a paginated list of guardrail rules for the current project." operationId: "GuardrailRuleList" parameters: - explode: false in: "query" name: "limit" schema: default: 10 format: "int64" maximum: 200 minimum: 1 type: "integer" - description: "A cursor for use in pagination." explode: false in: "query" name: "starting_after" schema: description: "A cursor for use in pagination." type: "string" - description: "A cursor for use in pagination." explode: false in: "query" name: "ending_before" schema: description: "A cursor for use in pagination." type: "string" - description: "Optional filter by project ID." explode: false in: "query" name: "project_id" schema: description: "Optional filter by project ID." type: "string" - description: "Filter by display name or description (case-insensitive)." explode: false in: "query" name: "search" schema: description: "Filter by display name or description (case-insensitive)." type: "string" - description: "Field to sort by. Defaults to created_at (newest first)." explode: false in: "query" name: "sort_by" schema: description: "Field to sort by. Defaults to created_at (newest first)." enum: - "created_at" - "updated_at" - "display_name" type: "string" - description: "Filter by enabled status." explode: false in: "query" name: "enabled" schema: description: "Filter by enabled status." type: - "boolean" - "null" - description: "Filter by referenced guardrail ids (comma-separated)." explode: false in: "query" name: "guardrail_id" schema: description: "Filter by referenced guardrail ids (comma-separated)." items: type: "string" type: - "array" - "null" responses: "200": content: application/json: schema: additionalProperties: false properties: data: items: $ref: "#/components/schemas/GuardrailRule" type: - "array" - "null" has_more: type: "boolean" object: type: "string" required: - "object" - "data" - "has_more" type: "object" description: "Guardrail rules retrieved successfully" summary: "List guardrail rules" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "list" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "list" security: - ApiKey: [] post: description: "Creates a new guardrail rule with expression, guardrails configuration, and timeout settings." operationId: "GuardrailRuleCreate" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" timeout: format: "int64" minimum: 1000 type: "integer" required: - "display_name" type: "object" required: true responses: "201": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" plugins: items: $ref: "#/components/schemas/Plugin" type: - "array" - "null" project_id: type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "timeout" type: "object" description: "Guardrail rule created successfully" "400": description: "Bad request" "409": description: "Name conflict" summary: "Create guardrail rule" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "create" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/guardrail-rules/used-guardrails: get: description: "Returns the distinct guardrail ids referenced across all guardrail rules in scope." operationId: "GuardrailRuleListUsedGuardrails" responses: "200": content: application/json: schema: additionalProperties: false properties: guardrail_ids: items: type: "string" type: - "array" - "null" object: type: "string" required: - "object" - "guardrail_ids" type: "object" description: "Used guardrails retrieved successfully" summary: "List used guardrails" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "listUsedGuardrails" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "listUsedGuardrails" security: - ApiKey: [] /v2/guardrail-rules/{guardrail_rule_id}: delete: description: "Deletes an existing guardrail rule by ID." operationId: "GuardrailRuleDelete" parameters: - description: "The ID of the guardrail rule" in: "path" name: "guardrail_rule_id" required: true schema: description: "The ID of the guardrail rule" type: "string" responses: "204": description: "Guardrail rule deleted successfully" "404": description: "Guardrail rule not found" summary: "Delete guardrail rule" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "delete" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "delete" security: - ApiKey: [] get: description: "Retrieves the details of an existing guardrail rule by ID." operationId: "GuardrailRuleGet" parameters: - description: "The ID of the guardrail rule" in: "path" name: "guardrail_rule_id" required: true schema: description: "The ID of the guardrail rule" type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" plugins: items: $ref: "#/components/schemas/Plugin" type: - "array" - "null" project_id: type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "timeout" type: "object" description: "Guardrail rule retrieved successfully" "404": description: "Guardrail rule not found" summary: "Get guardrail rule" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "retrieve" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "retrieve" security: - ApiKey: [] patch: description: "Partially updates an existing guardrail rule. Only provided fields are updated." operationId: "GuardrailRuleUpdate" parameters: - description: "The ID of the guardrail rule" in: "path" name: "guardrail_rule_id" required: true schema: description: "The ID of the guardrail rule" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: "array" timeout: format: "int64" minimum: 1000 type: "integer" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" guardrails: items: $ref: "#/components/schemas/GuardrailRef" type: - "array" - "null" plugins: items: $ref: "#/components/schemas/Plugin" type: - "array" - "null" project_id: type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "timeout" type: "object" description: "Guardrail rule updated successfully" "400": description: "Bad request" "404": description: "Guardrail rule not found" "409": description: "Name conflict" summary: "Update guardrail rule" tags: - "Guardrail Rules" x-cli-group: "guardrailRules" x-cli-hidden: true x-cli-name: "update" x-speakeasy-group: "guardrailRules" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/models: get: description: "Lists all available models for the workspace, including system and custom models with their enabled status." operationId: "ModelList" responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ModelDocument" type: - "array" - "null" description: "Models retrieved successfully" summary: "List models" tags: - "Models" x-cli-group: "models" x-cli-name: "list" x-code-samples: - label: "Node.js" lang: "typescript" source: "const models = await orq.models.list();" x-speakeasy-group: "models" x-speakeasy-ignore: true x-speakeasy-name-override: "list" security: - ApiKey: [] post: description: "Creates a new custom model for the workspace. Provider credentials in the configuration are encrypted using the workspace encryption key before being persisted." operationId: "ModelCreate" requestBody: content: application/json: schema: additionalProperties: false properties: configuration: additionalProperties: {} type: "object" display_name: maxLength: 128 type: "string" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: "number" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: maxLength: 256 type: "string" model_type: type: "string" output_cost: format: "double" type: "number" parameters: items: $ref: "#/components/schemas/CreateModelParameter" type: - "array" - "null" provider: type: "string" required: - "id" - "display_name" - "model_id" - "model_developer" - "model_family" - "model_type" - "provider" - "has_functions" - "input_cost" - "output_cost" - "metadata" - "parameters" - "configuration" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "Model created successfully" "400": description: "Invalid model configuration" "404": description: "Workspace not found" summary: "Create custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "create" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.create({\n id: \"...\",\n display_name: \"My custom model\",\n model_id: \"my-model\",\n provider: \"openai\",\n model_type: \"chat\",\n model_developer: \"openai\",\n model_family: \"gpt\",\n input_cost: 0,\n output_cost: 0,\n has_functions: false,\n metadata: { is_private: true, region: \"us\" },\n parameters: [],\n configuration: { provider: \"openai\", api_key: \"sk-...\" },\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/models/aws-bedrock: post: description: "Registers an AWS Bedrock inference profile as a custom model for the workspace. Credentials are resolved at request time via either the integration reference or pod-identity — nothing is stored with the model." operationId: "ModelCreateAwsBedrock" requestBody: content: application/json: schema: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" auth_mode: type: "string" autorouter_id: type: "string" autorouter_version: type: "string" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" integration_id: type: "string" max_tokens: format: "int64" type: "integer" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_adaptive_reasoning: type: "boolean" supports_extended_thinking: type: "boolean" supports_json_mode: type: "boolean" supports_json_schema: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "model_id" - "region" - "model_developer" - "auth_mode" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "AWS Bedrock model created successfully" "400": description: "Invalid model configuration" "404": description: "Workspace not found" summary: "Create AWS Bedrock custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "createAwsBedrock" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.createAwsBedrock({\n display_name: \"My Bedrock Model\",\n model_id: \"arn:aws:bedrock:us-east-1:123456789012:inference-profile/anthropic.claude-3-sonnet-20240229-v1:0\",\n region: \"us-east-1\",\n model_developer: \"anthropic\",\n auth_mode: \"integration\",\n integration_id: \"int_...\",\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "createAwsBedrock" security: - ApiKey: [] /v2/models/aws-bedrock/validate: post: description: "Performs a live Bedrock Converse probe to verify the inference profile ARN and credentials, then best-effort enriches the response from known system models." operationId: "ModelValidateAwsBedrock" requestBody: content: application/json: schema: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" auth_mode: type: "string" inference_profile_arn: type: "string" integration_id: type: "string" model_type: type: "string" region: type: "string" required: - "inference_profile_arn" - "region" - "auth_mode" type: "object" required: true responses: "200": description: "Validation result" "400": description: "Validation failed" "404": description: "Integration not found" summary: "Validate AWS Bedrock inference profile" tags: - "Models" x-cli-group: "models" x-cli-name: "validateAwsBedrock" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.validateAwsBedrock({\n inference_profile_arn: \"arn:aws:bedrock:us-east-1:123456789012:inference-profile/anthropic.claude-3-sonnet-20240229-v1:0\",\n region: \"us-east-1\",\n auth_mode: \"pod-identity\",\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "validateAwsBedrock" security: - ApiKey: [] /v2/models/aws-bedrock/{id}: patch: description: "Updates an AWS Bedrock custom model. ARN changes are format-validated (live AWS validation lives in the dedicated validate endpoint). Configuration and metadata are spread-merged. Parameters are replaced only when the request produces a non-empty list." operationId: "ModelUpdateAwsBedrock" parameters: - description: "The ID of the model" in: "path" name: "id" required: true schema: description: "The ID of the model" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: assume_role_arn: type: "string" assume_role_external_id: type: "string" autorouter_id: type: "string" autorouter_version: type: "string" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_developer: type: "string" model_family: type: "string" model_id: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_adaptive_reasoning: type: "boolean" supports_extended_thinking: type: "boolean" supports_json_mode: type: "boolean" supports_json_schema: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "AWS Bedrock model updated successfully" "400": description: "Invalid ARN format or request" "404": description: "Model not found or not accessible in this workspace" summary: "Update AWS Bedrock custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "updateAwsBedrock" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.updateAwsBedrock({\n id: \"019d...\",\n display_name: \"Updated name\",\n region: \"us-east-1\",\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "updateAwsBedrock" security: - ApiKey: [] /v2/models/azure-foundry/deployments: post: description: "Lists Azure Foundry deployments under the given base_url and joins each entry with the Orq master-data row. Only OpenAI-developed deployments in succeeded state with chat/completion/embedding/vision model types are returned." operationId: "ModelAzureFoundryDeployments" requestBody: content: application/json: schema: additionalProperties: false properties: api_key: type: "string" api_version: type: "string" base_url: type: "string" provider: type: "string" required: - "provider" - "base_url" - "api_key" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: deployments: items: $ref: "#/components/schemas/AzureFoundryDeployment" type: - "array" - "null" region: type: "string" required: - "region" - "deployments" type: "object" description: "Azure Foundry deployments listed" "400": description: "Invalid request or base_url" summary: "List Azure Foundry deployments under a resource" tags: - "Models" x-cli-group: "models" x-cli-name: "azureFoundryDeployments" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.azureFoundryDeployments({\n provider: \"azure\",\n base_url: \"https://my-resource.openai.azure.com/openai/v1\",\n api_key: \"...\",\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "azureFoundryDeployments" security: - ApiKey: [] /v2/models/litellm/import: post: description: "Bulk-imports a list of LiteLLM model definitions into the workspace model garden." operationId: "ModelLiteLLMImport" requestBody: content: application/json: schema: items: $ref: "#/components/schemas/LiteLLMModel" type: - "array" - "null" required: true responses: "200": content: application/json: schema: items: $ref: "#/components/schemas/ModelDocument" type: - "array" - "null" description: "LiteLLM models imported successfully" "400": description: "Invalid request" "404": description: "Workspace not found" summary: "Import models from LiteLLM" tags: - "Models" x-cli-group: "models" x-cli-name: "importLitellm" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.importLitellm([\n {\n model_name: \"gpt-4o-proxy\",\n litellm_params: {\n use_in_pass_through: false,\n use_litellm_proxy: true,\n merge_reasoning_content_in_choices: false,\n model: \"openai/gpt-4o\",\n },\n model_info: {\n id: null, db_model: null, key: null, litellm_provider: \"openai\", mode: \"chat\",\n input_cost_per_token: 0.0000025, output_cost_per_token: 0.00001,\n supports_function_calling: true,\n supported_openai_params: [\"temperature\", \"max_tokens\", \"top_p\"],\n },\n },\n]);" x-speakeasy-group: "models" x-speakeasy-name-override: "importLitellm" security: - ApiKey: [] /v2/models/litellm/models: get: description: "Fetches the list of models from the LiteLLM instance configured for the workspace. Requires a stored LiteLLM integration." operationId: "ModelListLitellm" responses: "200": content: application/json: schema: items: additionalProperties: {} type: "object" type: - "array" - "null" description: "LiteLLM models retrieved" "404": description: "LiteLLM integration not found" "500": description: "Error fetching models from LiteLLM" summary: "List models from configured LiteLLM instance" tags: - "Models" x-cli-group: "models" x-cli-name: "listLitellm" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.listLitellm();" x-speakeasy-group: "models" x-speakeasy-name-override: "listLitellm" security: - ApiKey: [] /v2/models/openai-like: post: description: "Creates a custom model backed by any OpenAI-compatible endpoint. The handler probes the target API with the supplied credentials before persisting the model." operationId: "ModelCreateOpenAILike" requestBody: content: application/json: schema: additionalProperties: false properties: api_key: type: "string" base_url: type: "string" cost_per_image: format: "double" type: "number" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_image_edit: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "region" - "base_url" - "model_id" - "api_key" - "model_type" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "OpenAI-like model created successfully" "400": description: "Invalid model configuration or validation failed" "404": description: "Workspace not found" summary: "Create OpenAI-compatible custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "createOpenaiLike" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.createOpenaiLike({\n display_name: \"My Local Model\",\n region: \"us\",\n base_url: \"https://api.example.com\",\n model_id: \"my-model\",\n api_key: \"sk-...\",\n model_type: \"chat\",\n input_cost: 0,\n output_cost: 0,\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "createOpenaiLike" security: - ApiKey: [] /v2/models/openai-like/{id}: patch: description: "Updates an OpenAI-compatible custom model. Live-re-probes the target API when base_url or model_id changes, using the stored encrypted api_key. Metadata is merged (existing preserved, new overrides)." operationId: "ModelUpdateOpenAILike" parameters: - description: "The ID of the model" in: "path" name: "id" required: true schema: description: "The ID of the model" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: base_url: type: "string" cost_per_image: format: "double" type: "number" description: type: "string" display_name: maxLength: 128 type: "string" has_reasoning: type: "boolean" input_cost: format: "double" type: "number" max_tokens: format: "int64" type: "integer" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: "number" region: type: "string" supports_image_edit: type: "boolean" supports_strict_tool: type: "boolean" supports_tool_calling: type: "boolean" supports_vision: type: "boolean" temperature: format: "double" type: "number" required: - "display_name" - "region" - "model_type" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "OpenAI-like model updated successfully" "400": description: "Invalid request or validation failed" "404": description: "Model not found or not accessible in this workspace" summary: "Update OpenAI-compatible custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "updateOpenaiLike" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.updateOpenaiLike({\n id: \"019d...\",\n display_name: \"My Renamed Model\",\n region: \"us\",\n model_type: \"chat\",\n input_cost: 0.002,\n output_cost: 0.004,\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "updateOpenaiLike" security: - ApiKey: [] /v2/models/validate: post: description: "Validates a provider endpoint by performing a minimal live probe. Currently supports Azure OpenAI. Response includes the resolved region, whether the model is known to Orq, and either the full model document or a synthesized default." operationId: "ModelValidate" requestBody: content: application/json: schema: additionalProperties: false properties: api_key: type: "string" api_version: type: "string" base_url: type: "string" deployment_name: type: "string" endpoint: type: "string" provider: type: "string" subtype: type: "string" required: - "provider" - "api_key" type: "object" required: true responses: "200": description: "Model validated" "400": description: "Invalid request or unsupported provider" "415": description: "Image models not supported" summary: "Validate model endpoint" tags: - "Models" x-cli-group: "models" x-cli-name: "validate" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.validate({\n provider: \"azure\",\n endpoint: \"https://my-deployment.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-06-01\",\n api_key: \"...\",\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "validate" security: - ApiKey: [] /v2/models/vertex: post: description: "Registers a Google Vertex AI model as a custom model for the workspace. The service account credentials are probed against Vertex AI with a minimal GenerateContent call before persisting." operationId: "ModelCreateVertex" requestBody: content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/VertexConfiguration" display_name: type: "string" required: - "display_name" - "configuration" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "Vertex AI model created successfully" "400": description: "Invalid model configuration or validation failed" "404": description: "Workspace not found" summary: "Create Vertex AI custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "createVertex" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.createVertex({\n display_name: \"My Vertex Gemini\",\n configuration: {\n projectId: \"my-gcp-project\",\n location: \"us-central1\",\n serviceAccount: { type: \"service_account\", project_id: \"...\" },\n modelConfiguration: {\n id: \"gemini-2.0-flash\",\n inputCost: 0,\n outputCost: 0,\n parameters: {\n temperature: { min: 0, max: 2 },\n maxTokens: { min: 1, max: 8192 },\n topP: { min: 0, max: 1 },\n },\n capabilities: { supportToolCalling: true, structuredOutput: true, vision: false },\n },\n },\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "createVertex" security: - ApiKey: [] /v2/models/{id}: delete: description: "Deletes a custom model from the workspace. System models cannot be deleted. Returns 200 with an explanatory message if the model is a system model or is still referenced by experiments." operationId: "ModelDelete" parameters: - description: "The ID of the model" in: "path" name: "id" required: true schema: description: "The ID of the model" type: "string" responses: "200": description: "Model deleted, or deletion refused with reason" "401": description: "Workspace ID required" summary: "Delete custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "delete" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.delete({ id: \"019d...\" });" x-speakeasy-group: "models" x-speakeasy-name-override: "delete" security: - ApiKey: [] patch: description: "Updates a custom model. Only fields present in the request body are modified, except for `metadata` and `parameters`, which are fully replaced when present (preserved from the legacy handler's behavior)." operationId: "ModelUpdate" parameters: - description: "The ID of the model" in: "path" name: "id" required: true schema: description: "The ID of the model" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: display_name: maxLength: 128 type: "string" has_functions: type: "boolean" input_cost: format: "double" type: "number" metadata: $ref: "#/components/schemas/ModelMetadata" model_type: type: "string" output_cost: format: "double" type: "number" parameters: items: $ref: "#/components/schemas/UpdateModelParameter" type: "array" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: configuration: $ref: "#/components/schemas/ModelConfigurationResponse" created: type: "string" description: type: - "string" - "null" display_name: type: "string" docs_url: type: - "string" - "null" enabled: type: "boolean" enabled_for_endpoints: type: "boolean" enabled_for_playground: type: "boolean" has_cpu_pricing: type: "boolean" has_functions: type: "boolean" id: type: "string" input_cost: format: "double" type: - "number" - "null" input_currency: type: "string" is_active: type: "boolean" legacy_uuid: type: "string" metadata: $ref: "#/components/schemas/ModelMetadata" model_developer: type: "string" model_family: type: "string" model_id: type: "string" model_type: type: "string" output_cost: format: "double" type: - "number" - "null" output_currency: type: "string" owner: type: "string" parameters: items: $ref: "#/components/schemas/ModelParameterDocument" type: - "array" - "null" pricing_url: type: - "string" - "null" provider: type: "string" refId: type: "string" sharing: $ref: "#/components/schemas/ModelSharingConfig" updated: type: "string" required: - "id" - "created" - "updated" - "display_name" - "model_id" - "is_active" - "provider" - "owner" - "input_cost" - "input_currency" - "output_cost" - "output_currency" - "description" - "pricing_url" - "docs_url" - "model_type" - "has_functions" - "has_cpu_pricing" - "enabled_for_playground" - "enabled_for_endpoints" - "configuration" - "metadata" - "parameters" - "enabled" - "refId" type: "object" description: "Model updated successfully" "400": description: "Invalid request" "404": description: "Model not found or not accessible in this workspace" summary: "Update custom model" tags: - "Models" x-cli-group: "models" x-cli-name: "update" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.update({\n id: \"019d...\",\n displayName: \"New display name\",\n hasFunctions: true,\n});" x-speakeasy-group: "models" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/policies: get: description: "Returns a paginated list of policies for the current project." operationId: "PolicyList" parameters: - explode: false in: "query" name: "limit" schema: default: 10 format: "int64" maximum: 200 minimum: 1 type: "integer" - description: "A cursor for use in pagination." explode: false in: "query" name: "starting_after" schema: description: "A cursor for use in pagination." type: "string" - description: "A cursor for use in pagination." explode: false in: "query" name: "ending_before" schema: description: "A cursor for use in pagination." type: "string" - description: "Optional filter by project ID." explode: false in: "query" name: "project_id" schema: description: "Optional filter by project ID." type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: data: items: $ref: "#/components/schemas/Policy" type: - "array" - "null" has_more: type: "boolean" object: type: "string" required: - "object" - "data" - "has_more" type: "object" description: "Policies retrieved successfully" summary: "List policies" tags: - "Policies" x-cli-group: "policies" x-cli-hidden: true x-cli-name: "list" x-speakeasy-group: "policies" x-speakeasy-name-override: "list" security: - ApiKey: [] post: description: "Creates a new router policy with model configuration, evaluators, retry settings, and limits." operationId: "PolicyCreate" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" timeout: format: "int64" minimum: 1000 type: "integer" required: - "display_name" type: "object" required: true responses: "201": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" slug: minLength: 1 type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "slug" - "enabled" - "timeout" type: "object" description: "Policy created successfully" "400": description: "Bad request" "409": description: "Slug conflict" summary: "Create policy" tags: - "Policies" x-cli-group: "policies" x-cli-hidden: true x-cli-name: "create" x-speakeasy-group: "policies" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/policies/{policy_id}: delete: description: "Deletes an existing policy by ID." operationId: "PolicyDelete" parameters: - description: "The ID of the policy" in: "path" name: "policy_id" required: true schema: description: "The ID of the policy" type: "string" responses: "204": description: "Policy deleted successfully" "404": description: "Policy not found" summary: "Delete policy" tags: - "Policies" x-cli-group: "policies" x-cli-hidden: true x-cli-name: "delete" x-speakeasy-group: "policies" x-speakeasy-name-override: "delete" security: - ApiKey: [] get: description: "Retrieves the details of an existing policy by ID." operationId: "PolicyGet" parameters: - description: "The ID of the policy" in: "path" name: "policy_id" required: true schema: description: "The ID of the policy" type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" slug: minLength: 1 type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "slug" - "enabled" - "timeout" type: "object" description: "Policy retrieved successfully" "404": description: "Policy not found" summary: "Get policy" tags: - "Policies" x-cli-group: "policies" x-cli-hidden: true x-cli-name: "retrieve" x-speakeasy-group: "policies" x-speakeasy-name-override: "retrieve" security: - ApiKey: [] patch: description: "Partially updates an existing policy. Only provided fields are updated." operationId: "PolicyUpdate" parameters: - description: "The ID of the policy" in: "path" name: "policy_id" required: true schema: description: "The ID of the policy" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: "array" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: description: "Optional project ID to assign the policy to." type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" timeout: format: "int64" minimum: 1000 type: "integer" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" evaluators: items: $ref: "#/components/schemas/EvaluatorRef" type: - "array" - "null" limits: $ref: "#/components/schemas/Limits" models_config: $ref: "#/components/schemas/ModelsConfig" project_id: type: "string" retry_config: $ref: "#/components/schemas/PolicyRetryConfig" slug: minLength: 1 type: "string" timeout: format: "int64" minimum: 1000 type: "integer" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "slug" - "enabled" - "timeout" type: "object" description: "Policy updated successfully" "400": description: "Bad request" "404": description: "Policy not found" "409": description: "Slug conflict" summary: "Update policy" tags: - "Policies" x-cli-group: "policies" x-cli-hidden: true x-cli-name: "update" x-speakeasy-group: "policies" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/routing-rules: get: description: "Returns a paginated list of routing rules for the current project, ordered by priority ascending." operationId: "RoutingRuleList" parameters: - explode: false in: "query" name: "limit" schema: default: 10 format: "int64" maximum: 200 minimum: 1 type: "integer" - description: "A cursor for use in pagination." explode: false in: "query" name: "starting_after" schema: description: "A cursor for use in pagination." type: "string" - description: "A cursor for use in pagination." explode: false in: "query" name: "ending_before" schema: description: "A cursor for use in pagination." type: "string" - description: "Optional filter by project ID." explode: false in: "query" name: "project_id" schema: description: "Optional filter by project ID." type: "string" - description: "Optional search term matched against name and description." explode: false in: "query" name: "search" schema: description: "Optional search term matched against name and description." type: "string" - description: "Filter by enabled status." explode: false in: "query" name: "enabled" schema: description: "Filter by enabled status." type: - "boolean" - "null" - description: "Filter by referenced model refs (comma-separated)." explode: false in: "query" name: "model" schema: description: "Filter by referenced model refs (comma-separated)." items: type: "string" type: - "array" - "null" responses: "200": content: application/json: schema: additionalProperties: false properties: data: items: $ref: "#/components/schemas/RoutingRule" type: - "array" - "null" has_more: type: "boolean" object: type: "string" required: - "object" - "data" - "has_more" type: "object" description: "Routing rules retrieved successfully" summary: "List routing rules" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "list" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "list" security: - ApiKey: [] post: description: "Creates a new routing rule with expression, models configuration, and priority settings." operationId: "RoutingRuleCreate" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: description: "Optional project ID. If null/omitted, the entity is global (workspace-wide)." type: "string" required: - "display_name" type: "object" required: true responses: "201": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: type: "string" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "priority" type: "object" description: "Routing rule created successfully" "400": description: "Bad request" "409": description: "Name conflict" summary: "Create routing rule" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "create" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/routing-rules/used-models: get: description: "Returns the distinct model refs referenced across all routing rules in scope." operationId: "RoutingRuleListUsedModels" responses: "200": content: application/json: schema: additionalProperties: false properties: models: items: type: "string" type: - "array" - "null" object: type: "string" required: - "object" - "models" type: "object" description: "Used models retrieved successfully" summary: "List used models" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "listUsedModels" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "listUsedModels" security: - ApiKey: [] /v2/routing-rules/{routing_rule_id}: delete: description: "Deletes an existing routing rule by ID." operationId: "RoutingRuleDelete" parameters: - description: "The ID of the routing rule" in: "path" name: "routing_rule_id" required: true schema: description: "The ID of the routing rule" type: "string" responses: "204": description: "Routing rule deleted successfully" "404": description: "Routing rule not found" summary: "Delete routing rule" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "delete" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "delete" security: - ApiKey: [] get: description: "Retrieves the details of an existing routing rule by ID." operationId: "RoutingRuleGet" parameters: - description: "The ID of the routing rule" in: "path" name: "routing_rule_id" required: true schema: description: "The ID of the routing rule" type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: type: "string" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "priority" type: "object" description: "Routing rule retrieved successfully" "404": description: "Routing rule not found" summary: "Get routing rule" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "retrieve" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "retrieve" security: - ApiKey: [] patch: description: "Partially updates an existing routing rule. Only provided fields are updated." operationId: "RoutingRuleUpdate" parameters: - description: "The ID of the routing rule" in: "path" name: "routing_rule_id" required: true schema: description: "The ID of the routing rule" type: "string" requestBody: content: application/json: schema: additionalProperties: false properties: description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/ExpressionInput" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: _id: type: "string" created_at: format: "date-time" type: "string" created_by_id: type: "string" description: maxLength: 2048 type: "string" display_name: maxLength: 256 minLength: 1 type: "string" enabled: type: "boolean" expression: $ref: "#/components/schemas/Expression" models_config: $ref: "#/components/schemas/ModelsConfig" priority: format: "int64" minimum: 0 type: "integer" project_id: type: "string" updated_at: format: "date-time" type: "string" updated_by_id: type: "string" required: - "_id" - "created_at" - "updated_at" - "created_by_id" - "updated_by_id" - "project_id" - "display_name" - "enabled" - "priority" type: "object" description: "Routing rule updated successfully" "400": description: "Bad request" "404": description: "Routing rule not found" "409": description: "Name conflict" summary: "Update routing rule" tags: - "Routing Rules" x-cli-group: "routingRules" x-cli-hidden: true x-cli-name: "update" x-speakeasy-group: "routingRules" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/workspace-models: post: description: "Adds the model to the workspace's enabled set. Idempotent — re-enabling an already-enabled model returns 204 with no state change." operationId: "ModelEnable" requestBody: content: application/json: schema: additionalProperties: false properties: model_id: type: "string" required: - "model_id" type: "object" required: true responses: "204": description: "Model enabled" "400": description: "Invalid request body" "404": description: "Model not found" "500": description: "Internal server error" summary: "Enable model for workspace" tags: - "Models" x-cli-group: "models" x-cli-name: "enable" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.enable({ modelId: \"model_123\" });" x-speakeasy-group: "models" x-speakeasy-name-override: "enable" security: - ApiKey: [] /v2/workspace-models/{model_id}: delete: description: "Removes the model from the workspace's enabled set. Idempotent — disabling an already-disabled model returns 204." operationId: "ModelDisable" parameters: - description: "The ID of the model to disable" in: "path" name: "model_id" required: true schema: description: "The ID of the model to disable" type: "string" responses: "204": description: "Model disabled" "400": description: "Invalid request" "500": description: "Internal server error" summary: "Disable model for workspace" tags: - "Models" x-cli-group: "models" x-cli-name: "disable" x-code-samples: - label: "Node.js" lang: "typescript" source: "await orq.models.disable({ modelId: \"model_123\" });" x-speakeasy-group: "models" x-speakeasy-name-override: "disable" security: - ApiKey: [] /v2/activity/{entity_id}: get: tags: - "Activities" summary: "List activities for an entity" operationId: "ActivityList" parameters: - name: "entity_id" in: "path" required: true schema: type: "string" - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "starting_after" in: "query" schema: type: "string" - name: "ending_before" in: "query" schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListActivitiesResponse" x-speakeasy-group: "activities" x-speakeasy-name-override: "list" x-speakeasy-ignore: true security: - ApiKey: [] post: tags: - "Activities" summary: "Create a new activity" operationId: "ActivityCreate" parameters: - name: "entity_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateActivityRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateActivityResponse" x-speakeasy-group: "activities" x-speakeasy-name-override: "create" x-speakeasy-ignore: true security: - ApiKey: [] /v2/activity/{entity_id}/{activity_id}: patch: tags: - "Activities" summary: "Update an activity" operationId: "ActivityUpdate" parameters: - name: "entity_id" in: "path" required: true schema: type: "string" - name: "activity_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateActivityRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateActivityResponse" x-speakeasy-group: "activities" x-speakeasy-name-override: "update" x-speakeasy-ignore: true security: - ApiKey: [] /v2/alerts: get: tags: - "Alerts" summary: "List alerts" description: "Returns the alerts visible to the caller, newest first. Use `starting_after` or `ending_before` to page." operationId: "AlertList" parameters: - name: "limit" in: "query" description: "Page size, 1-200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `alert_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `alert_id` of the first\n item from the previous page." schema: type: "string" - name: "project_id" in: "query" description: "Restrict results to one project." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListAlertsResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "list" security: - ApiKey: [] post: tags: - "Alerts" summary: "Create an alert" description: "Creates a threshold alert in a project. The alert's query is validated against the Reporting API metric catalogue and the evaluation schedule starts immediately when `enabled` is true. Plan limits apply to the number of alerts and the minimum evaluation interval." operationId: "AlertCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateAlertRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateAlertResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/alerts/{alert_id}: get: tags: - "Alerts" summary: "Retrieve an alert" description: "Retrieves an alert by ID." operationId: "AlertGet" parameters: - name: "alert_id" in: "path" description: "Alert ID to retrieve." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetAlertResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "get" security: - ApiKey: [] delete: tags: - "Alerts" summary: "Delete an alert" description: "Permanently deletes an alert together with its trigger history and events, and stops the evaluation schedule." operationId: "AlertDelete" parameters: - name: "alert_id" in: "path" description: "Alert ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteAlertResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "delete" security: - ApiKey: [] patch: tags: - "Alerts" summary: "Update an alert" description: "Updates alert metadata, query, condition, notifiers, or enabled state. Query and condition changes restart the evaluation schedule; disabling stops it. `project_id` is immutable." operationId: "AlertUpdate" parameters: - name: "alert_id" in: "path" description: "Alert ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateAlertRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateAlertResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/alerts/{alert_id}/triggers: get: tags: - "Alerts" summary: "List alert triggers" description: "Returns the trigger history of an alert, newest first. A trigger is one breach incident: it opens when the threshold is first crossed and resolves when the value recovers." operationId: "AlertListTriggers" parameters: - name: "alert_id" in: "path" description: "Alert whose triggers to list." required: true schema: type: "string" - name: "limit" in: "query" description: "Page size, 1-200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `trigger_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `trigger_id` of the\n first item from the previous page." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListAlertTriggersResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "listTriggers" security: - ApiKey: [] /v2/alerts/{alert_id}/triggers/{trigger_id}/events: get: tags: - "Alerts" summary: "List alert trigger events" description: "Returns the evaluation events recorded while a trigger was open, newest first. Each event carries the observed value and, when available, exemplar traces that contributed to the breach." operationId: "AlertListTriggerEvents" parameters: - name: "alert_id" in: "path" description: "Alert the trigger belongs to." required: true schema: type: "string" - name: "trigger_id" in: "path" description: "Trigger whose events to list." required: true schema: type: "string" - name: "limit" in: "query" description: "Page size, 1-200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `event_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `event_id` of the first\n item from the previous page." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListAlertTriggerEventsResponse" x-speakeasy-group: "alerts" x-speakeasy-name-override: "listTriggerEvents" security: - ApiKey: [] /v2/api-keys: get: tags: - "API keys" summary: "List API keys" description: "Returns API keys visible to the current workspace as a JSON array. Raw tokens are never included; the `token` field contains a masked display value." operationId: "ApiKeyList" parameters: - name: "limit" in: "query" description: "Page size, 1–200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `api_key_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `api_key_id` of the\n first item from the previous page." schema: type: "string" - name: "project_id" in: "query" description: "Optional filter: only return keys belonging to this project. When\n omitted, returns workspace-scoped and any single-project keys." schema: type: "string" - name: "status" in: "query" description: "Optional filter: only return keys with this status." schema: $ref: "#/components/schemas/ApiKeyStatus" - name: "search" in: "query" description: "Optional case-insensitive substring match against the api-key\n name. Empty means no name filter." schema: type: "string" - name: "owner_type" in: "query" description: "Optional filter: only return keys whose `owner.kind` matches\n one of the requested types. Combines the user / service-account\n oneof cases into a single repeated enum so the wire stays flat\n and multi-select filters travel as a single field. Empty means\n no owner-type filter." schema: type: "array" items: $ref: "#/components/schemas/OwnerType" - name: "permission_mode" in: "query" description: "Optional filter: only return keys whose permission mode is one\n of the listed presets. Empty means no permission-mode filter." schema: type: "array" items: $ref: "#/components/schemas/PermissionMode" - name: "include_budget" in: "query" description: "When true, embed each key's api-key-scoped budget (config and limits\n only, no live usage) on the returned records. Adds one budget lookup\n for the page; omit to skip it." schema: type: "boolean" responses: "200": description: API keys in the workspace. content: application/json: schema: type: array items: $ref: "#/components/schemas/ApiKeyRestResponse" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List active project keys" source: "curl --get 'https://api.orq.ai/v2/api-keys' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25' \\\n --data-urlencode 'project_id=proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --data-urlencode 'status=API_KEY_STATUS_ACTIVE'\n" - lang: "python" label: "Python - List active project keys" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\napi_keys = client.api_keys.list(\n limit=25,\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n status=\"API_KEY_STATUS_ACTIVE\",\n)\n\nfor api_key in api_keys:\n print(api_key.name, api_key.token)\n" - lang: "typescript" label: "Node.js - List active project keys" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst apiKeys = await client.apiKeys.list({\n limit: 25,\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n status: 'API_KEY_STATUS_ACTIVE',\n});\n\nfor (const apiKey of apiKeys) {\n console.log(apiKey.name, apiKey.token);\n}\n" security: - ApiKey: [] post: tags: - "API keys" summary: "Create a new API key" description: "Mints a new opaque API key (`sk-orq--`) in the workspace. The raw secret is returned ONCE in the response and is never retrievable afterwards. The stored record retains only `token_prefix` and a SHA-256 `token_hash`." operationId: "ApiKeyCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateApiKeyRequest" required: true responses: "200": description: API key created successfully. content: application/json: schema: $ref: "#/components/schemas/ApiKeyRestResponse" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create service account key" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/api-keys' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Production service key\",\n \"owner\": {\n \"service_account\": {}\n },\n \"project_scope\": {\n \"all\": {}\n },\n \"permission_mode\": \"PERMISSION_MODE_ALL\"\n }'\n" - lang: "python" label: "Python - Create service account key" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.api_keys.create(\n name=\"Production service key\",\n owner={\"service_account\": {}},\n project_scope={\"all\": {}},\n permission_mode=\"PERMISSION_MODE_ALL\",\n)\n\n# Store the token immediately. It is only returned once.\nprint(result.token)\n" - lang: "typescript" label: "Node.js - Create service account key" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.apiKeys.create({\n name: 'Production service key',\n owner: {\n serviceAccount: {},\n },\n projectScope: {\n all: {},\n },\n permissionMode: 'PERMISSION_MODE_ALL',\n});\n\n// Store the token immediately. It is only returned once.\nconsole.log(result.token);\n" - lang: "curl" label: "Core - Create restricted project key" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/api-keys' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Support automation key\",\n \"project_scope\": {\n \"single\": {\n \"project_id\": \"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\"\n }\n },\n \"permission_mode\": \"PERMISSION_MODE_RESTRICTED\",\n \"access\": {\n \"agents\": \"ACCESS_LEVEL_WRITE\",\n \"deployments\": \"ACCESS_LEVEL_READ\"\n }\n }'\n" - lang: "python" label: "Python - Create restricted project key" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.api_keys.create(\n name=\"Support automation key\",\n project_scope={\n \"single\": {\n \"project_id\": \"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n },\n },\n permission_mode=\"PERMISSION_MODE_RESTRICTED\",\n access={\n \"agents\": \"ACCESS_LEVEL_WRITE\",\n \"deployments\": \"ACCESS_LEVEL_READ\",\n },\n)\n\nprint(result.id)\nprint(result.token)\n" - lang: "typescript" label: "Node.js - Create restricted project key" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.apiKeys.create({\n name: 'Support automation key',\n projectScope: {\n single: {\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n },\n },\n permissionMode: 'PERMISSION_MODE_RESTRICTED',\n access: {\n agents: 'ACCESS_LEVEL_WRITE',\n deployments: 'ACCESS_LEVEL_READ',\n },\n});\n\nconsole.log(result.id);\nconsole.log(result.token);\n" security: - ApiKey: [] /v2/api-keys/capabilities: get: tags: - "API keys" summary: "List capability catalog" description: "Returns the capability catalog: the set of permission domains that can be granted to an API key. Each entry includes the domain id, display name, group, allowed project scopes, and the read / write verb sets resolved at authorize() time. Drives the permissions UI in the dashboard." operationId: "ApiKeyListCapabilities" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListCapabilitiesResponse" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "listCapabilities" x-code-samples: - lang: "curl" label: "Core - List capability catalog" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/api-keys/capabilities' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - List capability catalog" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\ncatalog = client.api_keys.list_capabilities()\n\nfor domain in catalog.domains:\n print(domain.id, domain.display_name)\n" - lang: "typescript" label: "Node.js - List capability catalog" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst catalog = await client.apiKeys.listCapabilities();\n\nfor (const domain of catalog.domains) {\n console.log(domain.id, domain.displayName);\n}\n" security: - ApiKey: [] /v2/api-keys/{api_key_id}: get: tags: - "API keys" summary: "Retrieve an API key" description: "Retrieves the metadata for an existing API key by its unique identifier. The raw secret is never returned — only `token_prefix`, `permission_mode`, `project_scope`, and lifecycle fields." operationId: "ApiKeyGet" parameters: - name: "api_key_id" in: "path" description: "API key id to retrieve (e.g. `01H...`)." required: true schema: type: "string" - name: "include_budget" in: "query" description: "When true, embed the api-key-scoped budget (config and limits only,\n no live usage) on the returned record." schema: type: "boolean" responses: "200": description: API key retrieved successfully. content: application/json: schema: $ref: "#/components/schemas/ApiKeyRestResponse" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve key metadata" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/api-keys/01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve key metadata" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.api_keys.get(\n api_key_id=\"01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.name)\n" - lang: "typescript" label: "Node.js - Retrieve key metadata" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.apiKeys.get({\n apiKeyId: '01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.name);\n" security: - ApiKey: [] delete: tags: - "API keys" summary: "Delete an API key" description: "Permanently deletes an API key. Cache entries in `API_KEYS_KV` are invalidated immediately so an in-flight token cannot ride out the TTL. The response body is empty on success." operationId: "ApiKeyDelete" parameters: - name: "api_key_id" in: "path" description: "API key id to delete." required: true schema: type: "string" responses: "204": description: API key deleted successfully. x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete a key" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/api-keys/01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete a key" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.api_keys.delete(\n api_key_id=\"01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n" - lang: "typescript" label: "Node.js - Delete a key" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.apiKeys.delete({\n apiKeyId: '01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n" security: - ApiKey: [] patch: tags: - "API keys" summary: "Update an API key" description: "Updates mutable fields of an API key: display name, status (active / disabled / revoked), permission mode and access map, project scope, and constraints (budget / rate limit / expiry). Omitted fields keep their current values." operationId: "ApiKeyUpdate" parameters: - name: "api_key_id" in: "path" description: "API key id to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateApiKeyRequest" required: true responses: "200": description: API key updated successfully. content: application/json: schema: $ref: "#/components/schemas/ApiKeyRestResponse" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Disable a key" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/api-keys/01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"status\": \"API_KEY_STATUS_DISABLED\"\n }'\n" - lang: "python" label: "Python - Disable a key" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.api_keys.update(\n api_key_id=\"01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n status=\"API_KEY_STATUS_DISABLED\",\n)\n\nprint(result.status)\n" - lang: "typescript" label: "Node.js - Disable a key" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.apiKeys.update({\n apiKeyId: '01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n status: 'API_KEY_STATUS_DISABLED',\n});\n\nconsole.log(result.status);\n" security: - ApiKey: [] /v2/budgets: get: tags: - "Budgets" summary: "List budgets" description: "Returns budgets visible to the current workspace, ordered by creation time with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that searches across denormalized target names via Typesense." operationId: "BudgetList" parameters: - name: "limit" in: "query" description: "Page size, 1–200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `budget_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `budget_id` of the\n first item from the previous page." schema: type: "string" - name: "scope_kind" in: "query" description: "Optional filter: only return budgets whose scope kind matches one\n of the listed values. Empty means no scope-kind filter." schema: type: "array" items: $ref: "#/components/schemas/BudgetScopeKind" - name: "scope_target_id" in: "query" description: "Optional filter: only return budgets whose scope target id matches." schema: type: "string" - name: "is_active" in: "query" description: "Optional filter: only return budgets with this active state." schema: type: "boolean" - name: "period" in: "query" description: "Optional filter: only return budgets whose limits.period matches\n one of the listed values. Empty means no period filter." schema: type: "array" items: $ref: "#/components/schemas/BudgetPeriod" - name: "query" in: "query" description: "Optional free-text query. Server translates this into a Typesense\n search over the denormalized `scope_target_name` and id fields on\n the per-workspace `{workspace_id}_budgets` collection." schema: type: "string" - name: "sort_by" in: "query" description: "Field used to order the list. Unset orders by most-recently-updated." schema: $ref: "#/components/schemas/BudgetSortField" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListBudgetsResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "list" security: - ApiKey: [] post: tags: - "Budgets" summary: "Create a new budget" description: "Creates a new budget in the workspace. Exactly one scope variant must be set (workspace / project / identity / api_key / provider / model). At least one of `limits.amount`, `limits.token_limit`, or `rate_limit.requests_per_minute` MUST be provided. Uniqueness is enforced across (workspace_id, scope_kind, scope_target_id)." operationId: "BudgetCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateBudgetRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateBudgetResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "create" x-code-samples: - lang: "typescript" label: "Node.js" source: "await orq.budgets.create({ scope: { kind: \"workspace\" }, limits: { period: \"MONTHLY\", amount: 1000 } });\n" security: - ApiKey: [] /v2/budgets/{budget_id}: get: tags: - "Budgets" summary: "Retrieve a budget" description: "Retrieves the metadata for an existing budget by its unique identifier. Returns `NotFound` when the budget does not exist in the caller's workspace." operationId: "BudgetGet" parameters: - name: "budget_id" in: "path" description: "Budget id to retrieve." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetBudgetResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "get" security: - ApiKey: [] delete: tags: - "Budgets" summary: "Delete a budget" description: "Permanently deletes a budget. Consumption counters in Redis for this budget are cleared immediately. The response body is empty on success." operationId: "BudgetDelete" parameters: - name: "budget_id" in: "path" description: "Budget id to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteBudgetResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "delete" security: - ApiKey: [] patch: tags: - "Budgets" summary: "Update a budget" description: "Updates mutable fields of a budget: limits, rate limit, activation, and expiration. The scope is immutable — to change a budget's target, delete and recreate it. Omitted fields keep their current values." operationId: "BudgetUpdate" parameters: - name: "budget_id" in: "path" description: "Budget id to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateBudgetRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateBudgetResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/budgets/{budget_id}/reset-consumption: post: tags: - "Budgets" summary: "Reset budget consumption" description: "Clears the current-period cost, token, and request counters for the budget. The budget record itself is preserved; only the Redis counters are reset." operationId: "BudgetResetConsumption" parameters: - name: "budget_id" in: "path" description: "Budget id whose current-period counters should be cleared." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/ResetBudgetConsumptionRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ResetBudgetConsumptionResponse" x-speakeasy-group: "budgets" x-speakeasy-name-override: "resetConsumption" security: - ApiKey: [] /v2/documentation/search: post: tags: - "Documentation" summary: "Search documentation" description: "Searches the orq.ai documentation index for the given query and returns the matching pages with content snippets and metadata." operationId: "DocumentationSearch" requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchDocumentationRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/SearchDocumentationResponse" x-speakeasy-group: "documentation" x-speakeasy-name-override: "search" x-cli-group: "documentation" x-cli-name: "search" x-cli-hidden: true x-speakeasy-ignore: true x-code-samples: - lang: "curl" label: "Core - Search documentation" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/documentation/search' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"query\": \"How do I create an API key?\",\n \"limit\": 5,\n \"score_threshold\": 0.65\n }'\n" - lang: "python" label: "Python - Search documentation" source: "import os\nimport requests\n\nresponse = requests.post(\n \"https://api.orq.ai/v2/documentation/search\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['ORQ_API_KEY']}\",\n \"Content-Type\": \"application/json\",\n },\n json={\n \"query\": \"How do I create an API key?\",\n \"limit\": 5,\n \"score_threshold\": 0.65,\n },\n timeout=30,\n)\nresponse.raise_for_status()\n\nfor result in response.json()[\"results\"]:\n print(result[\"metadata\"][\"title\"], result[\"metadata\"][\"href\"])\n" - lang: "typescript" label: "Node.js - Search documentation" source: "const response = await fetch('https://api.orq.ai/v2/documentation/search', {\n method: 'POST',\n headers: {\n Authorization: `Bearer ${process.env.ORQ_API_KEY}`,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({\n query: 'How do I create an API key?',\n limit: 5,\n score_threshold: 0.65,\n }),\n});\n\nif (!response.ok) {\n throw new Error(`Request failed: ${response.status}`);\n}\n\nconst { results } = await response.json();\nfor (const result of results) {\n console.log(result.metadata.title, result.metadata.href);\n}\n" security: - ApiKey: [] /v2/feature-previews: get: tags: - "FeaturePreviews" summary: "List feature previews" description: "Returns the full catalog of feature previews, each marked enabled\n according to the current user's saved choice (or its default)." operationId: "FeaturePreviewsList" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListFeaturePreviewsResponse" x-speakeasy-group: "featurePreviews" x-speakeasy-name-override: "list" x-cli-group: "featurePreviews" x-cli-name: "list" x-cli-hidden: true x-speakeasy-ignore: true security: - ApiKey: [] /v2/feature-previews/{slug}/toggle: post: tags: - "FeaturePreviews" summary: "Toggle feature preview" description: "Toggles a single feature preview on/off for the current user and\n returns its new state." operationId: "FeaturePreviewToggle" parameters: - name: "slug" in: "path" description: "Slug of the feature to toggle." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/ToggleFeaturePreviewRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ToggleFeaturePreviewResponse" x-speakeasy-group: "featurePreviews" x-speakeasy-name-override: "toggle" x-cli-group: "featurePreviews" x-cli-name: "toggle" x-cli-hidden: true x-speakeasy-ignore: true security: - ApiKey: [] /v2/files: get: tags: - "Files" summary: "List all files" description: "Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top." operationId: "FileList" parameters: - name: "limit" in: "query" description: "Page size. Unset uses the server default." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `file_id` of the last item\n from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `file_id` of the first item\n from the previous page." schema: type: "string" - name: "project_id" in: "query" schema: type: "string" - name: "purpose" in: "query" description: "Restrict results to files declared with this purpose. Accepts a purpose\n alias (`retrieval`, `knowledge_datasource`, `batch`, `code_interpreter`)\n or canonical `FILE_PURPOSE_*` name case-insensitively. Omit to list files\n of every purpose." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListFilesResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List project files" source: "curl --get 'https://api.orq.ai/v2/files' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25' \\\n --data-urlencode 'project_id=proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V'\n" - lang: "python" label: "Python - List project files" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.files.list(\n limit=25,\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nfor file in page.data:\n print(file.file_id, file.file_name)\n" - lang: "typescript" label: "Node.js - List project files" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.files.list({\n limit: 25,\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nfor (const file of page.data) {\n console.log(file.fileId, file.fileName);\n}\n" security: - ApiKey: [] post: tags: - "Files" summary: "Upload a file" description: "Files are used to upload documents that can be used with features like Deployments." operationId: "FileUpload" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateFileRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateFileResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Upload retrieval file" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/files' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"filename\": \"support-faq.md\",\n \"content\": \"IyBTdXBwb3J0IEZBUQoKQ29tbW9uIHJlc29sdXRpb25zIGFuZCBlc2NhbGF0aW9uIHBhdGhzLg==\",\n \"content_type\": \"text/markdown\",\n \"purpose\": \"FILE_PURPOSE_RETRIEVAL\",\n \"project_id\": \"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\"\n }'\n" - lang: "python" label: "Python - Upload retrieval file" source: "import base64\nimport os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\ncontent = base64.b64encode(\n b\"# Support FAQ\\n\\nCommon resolutions and escalation paths.\"\n).decode(\"utf-8\")\n\nresult = client.files.create(\n filename=\"support-faq.md\",\n content=content,\n content_type=\"text/markdown\",\n purpose=\"FILE_PURPOSE_RETRIEVAL\",\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.file.file_id)\n" - lang: "typescript" label: "Node.js - Upload retrieval file" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst content = Buffer.from(\n '# Support FAQ\\n\\nCommon resolutions and escalation paths.',\n).toString('base64');\n\nconst result = await client.files.create({\n filename: 'support-faq.md',\n content,\n contentType: 'text/markdown',\n purpose: 'FILE_PURPOSE_RETRIEVAL',\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.file.fileId);\n" security: - ApiKey: [] /v2/files/{file_id_or_path}/content: get: tags: - "Files" summary: "Download file content" description: "Returns a presigned URL for downloading the file content by file ID." operationId: "FileContent" parameters: - name: "file_id_or_path" in: "path" description: "File ID or path used to locate the file content." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetFileContentResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "getContent" x-code-samples: - lang: "curl" label: "Core - Get download URL" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/files/file_01HZXW2K7Y8Q9M0N1P2R3S4T5V/content' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Get download URL" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.files.get_content(\n file_id_or_path=\"file_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.download_url)\n" - lang: "typescript" label: "Node.js - Get download URL" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.files.getContent({\n fileIdOrPath: 'file_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.downloadUrl);\n" security: - ApiKey: [] /v2/files/{file_id}: get: tags: - "Files" summary: "Retrieve a file" description: "Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object." operationId: "FileGet" parameters: - name: "file_id" in: "path" description: "File ID to retrieve." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetFileResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve file metadata" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/files/file_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve file metadata" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.files.get(\n file_id=\"file_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.file.file_name)\n" - lang: "typescript" label: "Node.js - Retrieve file metadata" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.files.get({\n fileId: 'file_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.file.fileName);\n" security: - ApiKey: [] delete: tags: - "Files" summary: "Delete a file" description: "Permanently deletes a file and its stored content from the project." operationId: "FileDelete" parameters: - name: "file_id" in: "path" description: "File ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteFileResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete file" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/files/file_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete file" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.files.delete(\n file_id=\"file_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n" - lang: "typescript" label: "Node.js - Delete file" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.files.delete({\n fileId: 'file_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n" security: - ApiKey: [] patch: tags: - "Files" summary: "Update a file" description: "Updates the metadata of an existing file object." operationId: "FileUpdate" parameters: - name: "file_id" in: "path" description: "File ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateFileRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateFileResponse" x-speakeasy-group: "files" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Rename file" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/files/file_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"file_name\": \"support-faq-v2.md\"\n }'\n" - lang: "python" label: "Python - Rename file" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.files.update(\n file_id=\"file_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n file_name=\"support-faq-v2.md\",\n)\n\nprint(result.file.file_name)\n" - lang: "typescript" label: "Node.js - Rename file" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.files.update({\n fileId: 'file_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n fileName: 'support-faq-v2.md',\n});\n\nconsole.log(result.file.fileName);\n" security: - ApiKey: [] /v2/finder: get: tags: - "Finder" summary: "List finder entities" description: "Returns all finder entities for the current workspace. Owned entities are scoped to the active project; structural entities and skills remain workspace-wide." operationId: "ListFinderEntities" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListFinderEntitiesResponse" x-speakeasy-group: "finder" x-speakeasy-name-override: "list" x-cli-group: "finder" x-cli-name: "list" x-cli-hidden: true x-speakeasy-ignore: true security: - ApiKey: [] /v2/finder/{id}: get: tags: - "Finder" summary: "Retrieve a finder entity" description: "Returns a single finder entity by id, scoped to the caller's workspace membership." operationId: "GetFinderEntity" parameters: - name: "id" in: "path" description: "Identifier of the finder entity to retrieve. Matches the `_id` field." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/FinderItem" x-speakeasy-group: "finder" x-speakeasy-name-override: "get" x-cli-group: "finder" x-cli-name: "get" x-cli-hidden: true x-speakeasy-ignore: true security: - ApiKey: [] /v2/identities: get: tags: - "Identities" summary: "List identities" description: "Retrieves a paginated list of identities in your workspace. Use pagination parameters to navigate through large identity lists efficiently." operationId: "ListIdentities" parameters: - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `_id` of the last item from\n the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `_id` of the first item from\n the previous page." schema: type: "string" - name: "search" in: "query" description: "Case-insensitive search text matched against identity profile fields." schema: type: "string" - name: "filter_by.tags" in: "query" description: "Return only identities that have at least one of these tags." schema: type: "array" items: type: "string" - name: "include_metrics" in: "query" description: "Include aggregate usage metrics on each returned identity." schema: type: "boolean" - name: "sort_by" in: "query" description: "Field used to order the list." schema: $ref: "#/components/schemas/IdentitySortField" - name: "include_budget" in: "query" description: "When true, embed each identity's identity-scoped budget (config and\n limits only, no live usage) on the returned records. Adds one budget\n lookup for the page; omit to skip it." schema: type: "boolean" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListIdentitiesResponse" x-speakeasy-group: "identities" x-speakeasy-name-override: "list" x-cli-group: "identities" x-cli-name: "list" x-code-samples: - lang: "curl" label: "Core - List identities by tag" source: "curl --get 'https://api.orq.ai/v2/identities' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25' \\\n --data-urlencode 'search=acme' \\\n --data-urlencode 'filter_by.tags=enterprise' \\\n --data-urlencode 'include_metrics=true'\n" - lang: "python" label: "Python - List identities by tag" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.identities.list(\n limit=25,\n search=\"acme\",\n filter_by={\"tags\": [\"enterprise\"]},\n include_metrics=True,\n)\n\nfor identity in page.data:\n print(identity.external_id, identity.display_name)\n" - lang: "typescript" label: "Node.js - List identities by tag" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.identities.list({\n limit: 25,\n search: 'acme',\n filterBy: {\n tags: ['enterprise'],\n },\n includeMetrics: true,\n});\n\nfor (const identity of page.data) {\n console.log(identity.externalId, identity.displayName);\n}\n" security: - ApiKey: [] post: tags: - "Identities" summary: "Create an identity" description: "Creates a new identity with a unique external_id. If an identity with the same external_id already exists, the operation will fail." operationId: "CreateIdentity" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIdentityRequest" required: true responses: "201": description: "Identity created successfully." content: application/json: schema: $ref: "#/components/schemas/CreateIdentityResponse" x-speakeasy-group: "identities" x-speakeasy-name-override: "create" x-cli-group: "identities" x-cli-name: "create" x-code-samples: - lang: "curl" label: "Core - Create customer identity" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/identities' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"external_id\": \"customer_12345\",\n \"display_name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\",\n \"tags\": [\"enterprise\", \"beta\"],\n \"metadata\": {\n \"plan\": \"enterprise\",\n \"region\": \"eu\"\n }\n }'\n" - lang: "python" label: "Python - Create customer identity" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.identities.create(\n external_id=\"customer_12345\",\n display_name=\"Ada Lovelace\",\n email=\"ada@example.com\",\n tags=[\"enterprise\", \"beta\"],\n metadata={\n \"plan\": \"enterprise\",\n \"region\": \"eu\",\n },\n)\n\nprint(result.identity.external_id)\n" - lang: "typescript" label: "Node.js - Create customer identity" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.identities.create({\n externalId: 'customer_12345',\n displayName: 'Ada Lovelace',\n email: 'ada@example.com',\n tags: ['enterprise', 'beta'],\n metadata: {\n plan: 'enterprise',\n region: 'eu',\n },\n});\n\nconsole.log(result.identity.externalId);\n" - lang: "curl" label: "Core - Create minimal identity" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/identities' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"external_id\": \"user_9f4b2a\"\n }'\n" - lang: "python" label: "Python - Create minimal identity" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.identities.create(\n external_id=\"user_9f4b2a\",\n)\n\nprint(result.identity.external_id)\n" - lang: "typescript" label: "Node.js - Create minimal identity" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.identities.create({\n externalId: 'user_9f4b2a',\n});\n\nconsole.log(result.identity.externalId);\n" security: - ApiKey: [] /v2/identities/{id}: get: tags: - "Identities" summary: "Retrieve an identity" description: "Retrieves detailed information about a specific identity using their identity ID or external ID from your system." operationId: "RetrieveIdentity" parameters: - name: "id" in: "path" description: "Identity ID to retrieve." required: true schema: type: "string" - name: "include_metrics" in: "query" description: "Include aggregate usage metrics on the returned identity." schema: type: "boolean" - name: "include_budget" in: "query" description: "When true, embed the identity-scoped budget (config and limits only,\n no live usage) on the returned record." schema: type: "boolean" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/RetrieveIdentityResponse" x-speakeasy-group: "identities" x-speakeasy-name-override: "retrieve" x-cli-group: "identities" x-cli-name: "retrieve" x-code-samples: - lang: "curl" label: "Core - Retrieve identity with metrics" source: "curl --get 'https://api.orq.ai/v2/identities/customer_12345' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'include_metrics=true'\n" - lang: "python" label: "Python - Retrieve identity with metrics" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.identities.retrieve(\n id=\"customer_12345\",\n include_metrics=True,\n)\n\nprint(result.identity.display_name)\nprint(result.identity.metrics.total_requests)\n" - lang: "typescript" label: "Node.js - Retrieve identity with metrics" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.identities.retrieve({\n id: 'customer_12345',\n includeMetrics: true,\n});\n\nconsole.log(result.identity.displayName);\nconsole.log(result.identity.metrics.totalRequests);\n" security: - ApiKey: [] delete: tags: - "Identities" summary: "Delete an identity" description: "Permanently deletes an identity from your workspace and cleans up associated budget configurations." operationId: "DeleteIdentity" parameters: - name: "id" in: "path" description: "Identity ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteIdentityResponse" x-speakeasy-group: "identities" x-speakeasy-name-override: "delete" x-cli-group: "identities" x-cli-name: "delete" x-code-samples: - lang: "curl" label: "Core - Delete identity" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/identities/customer_12345' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete identity" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.identities.delete(\n id=\"customer_12345\",\n)\n" - lang: "typescript" label: "Node.js - Delete identity" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.identities.delete({\n id: 'customer_12345',\n});\n" security: - ApiKey: [] patch: tags: - "Identities" summary: "Update an identity" description: "Updates specific fields of an existing identity. Only the fields provided in the request body will be updated." operationId: "UpdateIdentity" parameters: - name: "id" in: "path" description: "Identity ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIdentityRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateIdentityResponse" x-speakeasy-group: "identities" x-speakeasy-name-override: "update" x-cli-group: "identities" x-cli-name: "update" x-code-samples: - lang: "curl" label: "Core - Update identity profile" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/identities/customer_12345' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"display_name\": \"Ada L.\",\n \"tags\": [\"enterprise\", \"priority\"],\n \"metadata\": {\n \"plan\": \"enterprise\",\n \"lifecycle\": \"renewal\"\n }\n }'\n" - lang: "python" label: "Python - Update identity profile" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.identities.update(\n id=\"customer_12345\",\n display_name=\"Ada L.\",\n tags=[\"enterprise\", \"priority\"],\n metadata={\n \"plan\": \"enterprise\",\n \"lifecycle\": \"renewal\",\n },\n)\n\nprint(result.identity.display_name)\n" - lang: "typescript" label: "Node.js - Update identity profile" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.identities.update({\n id: 'customer_12345',\n displayName: 'Ada L.',\n tags: ['enterprise', 'priority'],\n metadata: {\n plan: 'enterprise',\n lifecycle: 'renewal',\n },\n});\n\nconsole.log(result.identity.displayName);\n" security: - ApiKey: [] /v2/management-keys: get: tags: - "Management keys" summary: "List management keys" description: "Returns management keys in the current workspace, ordered by creation time with the newest key first. The `api_key` and `token_hash` fields are never returned by this endpoint; only `token_prefix` is included." operationId: "ManagementKeyList" parameters: - name: "limit" in: "query" description: "Page size, 1–200. Unset uses the server default (25)." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `management_key_id` of the\n last item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `management_key_id` of the\n first item from the previous page." schema: type: "string" - name: "status" in: "query" description: "Optional filter: only return keys with this status." schema: $ref: "#/components/schemas/ManagementKeyStatus" - name: "search" in: "query" description: "Optional case-insensitive substring match against the management-key\n name. Empty means no name filter." schema: type: "string" - name: "permission_mode" in: "query" description: "Optional filter: only return keys whose permission mode is one of\n the listed presets. Empty means no permission-mode filter." schema: type: "array" items: $ref: "#/components/schemas/ManagementPermissionMode" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListManagementKeysResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "list" security: - ApiKey: [] post: tags: - "Management keys" summary: "Create a new management key" description: "Mints a new opaque management key (`sk-orq--`) in the workspace. The raw secret is returned ONCE in the response and is never retrievable afterwards. The stored record retains only `token_prefix` and a SHA-256 `token_hash`." operationId: "ManagementKeyCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateManagementKeyRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateManagementKeyResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/management-keys/capabilities: get: tags: - "Management keys" summary: "List management capability catalog" description: "Returns the management capability catalog: the set of workspace-admin permission domains that can be granted to a management key. Each entry includes the domain id, display name, group, and the read / write verb support. Drives the permissions UI in the dashboard." operationId: "ManagementKeyListCapabilities" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListManagementCapabilitiesResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "listCapabilities" security: - ApiKey: [] /v2/management-keys/{management_key_id}: get: tags: - "Management keys" summary: "Retrieve a management key" description: "Retrieves the metadata for an existing management key by its unique identifier. The raw secret is never returned — only `token_prefix`, `permission_mode`, and lifecycle fields." operationId: "ManagementKeyGet" parameters: - name: "management_key_id" in: "path" description: "Management key id to retrieve (e.g. `01H...`)." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetManagementKeyResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "get" security: - ApiKey: [] delete: tags: - "Management keys" summary: "Delete a management key" description: "Permanently deletes a management key. Cache entries are invalidated immediately so an in-flight token cannot ride out the TTL. The response body is empty on success." operationId: "ManagementKeyDelete" parameters: - name: "management_key_id" in: "path" description: "Management key id to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteManagementKeyResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "delete" security: - ApiKey: [] patch: tags: - "Management keys" summary: "Update a management key" description: "Updates mutable fields of a management key: display name, status (active / disabled / revoked), permission mode and access map, and expiry. Omitted fields keep their current values." operationId: "ManagementKeyUpdate" parameters: - name: "management_key_id" in: "path" description: "Management key id to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateManagementKeyRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateManagementKeyResponse" x-speakeasy-group: "managementKeys" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/models/{model_id}/sharing: put: tags: - "Model Sharing" summary: "Set a model's sharing config" description: "Persists the project sharing config for a workspace model. Exactly one sharing mode must be set (all_projects / selected)." operationId: "ModelSharingSet" parameters: - name: "model_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/Sharing" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/SetModelSharingResponse" x-speakeasy-group: "modelSharing" x-speakeasy-name-override: "set" x-cli-hidden: true x-speakeasy-ignore: true security: - ApiKey: [] /v2/notifiers: get: tags: - "Notifiers" summary: "List notifiers" description: "Returns notifier destinations visible to the caller, ordered by creation time with the newest notifier first." operationId: "NotifierList" parameters: - name: "limit" in: "query" description: "Optional. Number of notifiers to return. Defaults to 25 and must be between 1 and 200." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `_id` of the last item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `_id` of the first item from the previous page." schema: type: "string" - name: "project_id" in: "query" description: "Restrict results to one project. Must be a project the caller is authorized for." schema: type: "string" - name: "search" in: "query" description: "Optional. Case-insensitive substring match on the notifier name." schema: type: "string" - name: "type" in: "query" description: "Optional. Restrict results to these notifier types." schema: type: "array" items: $ref: "#/components/schemas/NotifierType" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListNotifiersResponse" x-speakeasy-group: "notifiers" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List notifiers" source: "curl --get 'https://api.orq.ai/v2/notifiers' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'project_id=proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --data-urlencode 'limit=25'\n" - lang: "python" label: "Python - List notifiers" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.notifiers.list(\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n limit=25,\n)\n\nfor notifier in page.data:\n print(notifier._id, notifier.display_name)\n" - lang: "typescript" label: "Node.js - List notifiers" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.notifiers.list({\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n limit: 25,\n});\n\nfor (const notifier of page.data) {\n console.log(notifier._id, notifier.displayName);\n}\n" security: - ApiKey: [] post: tags: - "Notifiers" summary: "Create a notifier" description: "Creates a notifier destination in a project. Choose `NOTIFIER_TYPE_EMAIL`, `NOTIFIER_TYPE_SLACK_WEBHOOK`, or `NOTIFIER_TYPE_WEBHOOK` and provide the matching destination fields." operationId: "NotifierCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateNotifierRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateNotifierResponse" x-speakeasy-group: "notifiers" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create email notifier" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/notifiers' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"project_id\": \"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n \"display_name\": \"Production alerts\",\n \"type\": \"NOTIFIER_TYPE_EMAIL\",\n \"emails\": [\"ops@example.com\", \"alerts@example.com\"],\n \"metadata\": {\"environment\": \"production\"}\n }'\n" - lang: "python" label: "Python - Create email notifier" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.notifiers.create(\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n display_name=\"Production alerts\",\n type=\"NOTIFIER_TYPE_EMAIL\",\n emails=[\"ops@example.com\", \"alerts@example.com\"],\n metadata={\"environment\": \"production\"},\n)\n\nprint(result.notifier._id)\n" - lang: "typescript" label: "Node.js - Create email notifier" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.notifiers.create({\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n displayName: 'Production alerts',\n type: 'NOTIFIER_TYPE_EMAIL',\n emails: ['ops@example.com', 'alerts@example.com'],\n metadata: { environment: 'production' },\n});\n\nconsole.log(result.notifier._id);\n" security: - ApiKey: [] /v2/notifiers/{notifier_id}: get: tags: - "Notifiers" summary: "Retrieve a notifier" description: "Retrieves an existing notifier by ID." operationId: "NotifierGet" parameters: - name: "notifier_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetNotifierResponse" x-speakeasy-group: "notifiers" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve notifier" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/notifiers/notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve notifier" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.notifiers.get(\n notifier_id=\"notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.notifier.display_name)\n" - lang: "typescript" label: "Node.js - Retrieve notifier" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.notifiers.get({\n notifierId: 'notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.notifier.displayName);\n" security: - ApiKey: [] delete: tags: - "Notifiers" summary: "Delete a notifier" description: "Deletes an existing notifier by ID." operationId: "NotifierDelete" parameters: - name: "notifier_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteNotifierResponse" x-speakeasy-group: "notifiers" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete notifier" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/notifiers/notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete notifier" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.notifiers.delete(\n notifier_id=\"notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n" - lang: "typescript" label: "Node.js - Delete notifier" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.notifiers.delete({\n notifierId: 'notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n" security: - ApiKey: [] patch: tags: - "Notifiers" summary: "Update a notifier" description: "Partially updates an existing notifier. When changing `type`, provide the destination fields required by the new notifier type." operationId: "NotifierUpdate" parameters: - name: "notifier_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateNotifierRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateNotifierResponse" x-speakeasy-group: "notifiers" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Update notifier" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/notifiers/notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"display_name\": \"Production incident alerts\",\n \"emails\": [\"incidents@example.com\"]\n }'\n" - lang: "python" label: "Python - Update notifier" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.notifiers.update(\n notifier_id=\"notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n display_name=\"Production incident alerts\",\n emails=[\"incidents@example.com\"],\n)\n\nprint(result.notifier.display_name)\n" - lang: "typescript" label: "Node.js - Update notifier" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.notifiers.update({\n notifierId: 'notifier_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n displayName: 'Production incident alerts',\n emails: ['incidents@example.com'],\n});\n\nconsole.log(result.notifier.displayName);\n" security: - ApiKey: [] /v2/people: get: tags: - "People" summary: "List all people" description: "Returns a paginated list of people in the current workspace. Use `starting_after` or `ending_before` to page through large collections." operationId: "PersonList" parameters: - name: "limit" in: "query" description: "Page size, 1-200. Unset uses the server default." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `id` of the first\n item from the previous page." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListPeopleResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "list" security: - ApiKey: [] post: tags: - "People" summary: "Invite people to a workspace" description: "Invites one or more people to the current workspace. If an email is not already registered, a new account is created and an invitation email is sent. Existing accounts are linked directly to the workspace." operationId: "PersonCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePersonRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreatePersonResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "create" security: - ApiKey: [] /v2/people/{person_id}: get: tags: - "People" summary: "Retrieve a person" description: "Retrieves the details of an existing workspace member or invited user by their person ID." operationId: "PersonGet" parameters: - name: "person_id" in: "path" description: "Person ID to retrieve." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetPersonResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "get" security: - ApiKey: [] delete: tags: - "People" summary: "Delete a person" description: "Removes a member or invited user from the workspace. API keys owned by the removed user are cascade revoked. The response body is empty when the delete succeeds." operationId: "PersonDelete" parameters: - name: "person_id" in: "path" description: "Person ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeletePersonResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "delete" security: - ApiKey: [] patch: tags: - "People" summary: "Update a person" description: "Updates the roles and group assignments of a workspace member. Omitted fields keep their current values." operationId: "PersonUpdate" parameters: - name: "person_id" in: "path" description: "Person ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdatePersonRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdatePersonResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/people/{person_id}:resend: post: tags: - "People" summary: "Resend invitation" description: "Resends the invitation email to a pending workspace member. Has no effect if the person has already accepted." operationId: "PersonResendInvitation" parameters: - name: "person_id" in: "path" description: "Person ID of the pending invite to resend." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/ResendInvitationRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ResendInvitationResponse" x-speakeasy-group: "people" x-speakeasy-name-override: "resendInvitation" security: - ApiKey: [] /v2/projects: get: tags: - "Projects" summary: "List all projects" description: "Returns projects visible to the current workspace, ordered by creation time with the newest project first. Use `starting_after` or `ending_before` to page through large collections." operationId: "ProjectList" parameters: - name: "limit" in: "query" description: "Page size, 1-200. Unset uses the server default." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `project_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `project_id` of the first\n item from the previous page." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListProjectsResponse" x-speakeasy-group: "projects" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List projects" source: "curl --get 'https://api.orq.ai/v2/projects' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25'\n" - lang: "python" label: "Python - List projects" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.projects.list(\n limit=25,\n)\n\nfor project in page.data:\n print(project.project_id, project.name)\n" - lang: "typescript" label: "Node.js - List projects" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.projects.list({\n limit: 25,\n});\n\nfor (const project of page.data) {\n console.log(project.projectId, project.name);\n}\n" security: - ApiKey: [] post: tags: - "Projects" summary: "Create a new project" description: "Creates a project in the current workspace. Projects are workspace-level containers for resources such as skills, deployments, datasets, rules, and related team access." operationId: "ProjectCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateProjectRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateProjectResponse" x-speakeasy-group: "projects" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create project" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/projects' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Customer Success\",\n \"description\": \"Production automations for customer success workflows\",\n \"teams\": [\"team_support\", \"team_growth\"]\n }'\n" - lang: "python" label: "Python - Create project" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.projects.create(\n name=\"Customer Success\",\n description=\"Production automations for customer success workflows\",\n teams=[\"team_support\", \"team_growth\"],\n)\n\nprint(result.project.project_id)\n" - lang: "typescript" label: "Node.js - Create project" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.projects.create({\n name: 'Customer Success',\n description: 'Production automations for customer success workflows',\n teams: ['team_support', 'team_growth'],\n});\n\nconsole.log(result.project.projectId);\n" security: - ApiKey: [] /v2/projects/{project_id}: get: tags: - "Projects" summary: "Retrieve a project" description: "Retrieves the details of an existing project by its unique project ID." operationId: "ProjectGet" parameters: - name: "project_id" in: "path" description: "Project ID to retrieve." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetProjectResponse" x-speakeasy-group: "projects" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve project" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/projects/proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve project" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.projects.get(\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.project.name)\n" - lang: "typescript" label: "Node.js - Retrieve project" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.projects.get({\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.project.name);\n" security: - ApiKey: [] delete: tags: - "Projects" summary: "Delete a project" description: "Deletes a project from the workspace. The response body is empty when the delete succeeds." operationId: "ProjectDelete" parameters: - name: "project_id" in: "path" description: "Project ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteProjectResponse" x-speakeasy-group: "projects" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete project" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/projects/proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete project" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.projects.delete(\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n" - lang: "typescript" label: "Node.js - Delete project" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.projects.delete({\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n" security: - ApiKey: [] patch: tags: - "Projects" summary: "Update a project" description: "Updates the specified project by setting the values of the parameters passed." operationId: "ProjectUpdate" parameters: - name: "project_id" in: "path" description: "Project ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateProjectRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateProjectResponse" x-speakeasy-group: "projects" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Update project" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/projects/proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Customer Success Production\",\n \"description\": \"Production support and retention automations\",\n \"teams\": [\"team_support\"]\n }'\n" - lang: "python" label: "Python - Update project" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.projects.update(\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n name=\"Customer Success Production\",\n description=\"Production support and retention automations\",\n teams=[\"team_support\"],\n)\n\nprint(result.project.name)\n" - lang: "typescript" label: "Node.js - Update project" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.projects.update({\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n name: 'Customer Success Production',\n description: 'Production support and retention automations',\n teams: ['team_support'],\n});\n\nconsole.log(result.project.name);\n" security: - ApiKey: [] /v2/skills: get: tags: - "Skills" summary: "List all skills" description: "Returns the skills visible to the current workspace, ordered by creation time with the newest skill first. Use `starting_after` or `ending_before` to page through large collections." operationId: "SkillList" parameters: - name: "limit" in: "query" description: "Page size, 1–200. Unset uses the server default (25); explicit 0\n (or anything outside the range) is rejected by buf.validate." schema: type: "integer" format: "int32" - name: "starting_after" in: "query" description: "Cursor for forward pagination. Set to the `skill_id` of the last\n item from the previous page." schema: type: "string" - name: "ending_before" in: "query" description: "Cursor for backward pagination. Set to the `skill_id` of the first\n item from the previous page." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListSkillsResponse" x-speakeasy-group: "skills" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List skills" source: "curl --get 'https://api.orq.ai/v2/skills' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25'\n" - lang: "python" label: "Python - List skills" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.skills.list(\n limit=25,\n)\n\nfor skill in page.data:\n print(skill.skill_id, skill.display_name)\n" - lang: "typescript" label: "Node.js - List skills" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.skills.list({\n limit: 25,\n});\n\nfor (const skill of page.data) {\n console.log(skill.skillId, skill.displayName);\n}\n" security: - ApiKey: [] post: tags: - "Skills" summary: "Create a new skill" description: "Creates a reusable skill in the workspace. Skills store instructions, metadata, and an optional project location so teams can standardize repeatable AI workflows." operationId: "SkillCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSkillRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateSkillResponse" x-speakeasy-group: "skills" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create project skill" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/skills' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"display_name\": \"summarize_support_ticket\",\n \"description\": \"Summarize support tickets into concise resolution notes.\",\n \"project_id\": \"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n \"path\": \"/customer-success/skills/summarize-support-ticket\",\n \"tags\": [\"support\", \"summarization\"],\n \"instructions\": \"Read the ticket conversation and return the problem, customer sentiment, and proposed next step.\"\n }'\n" - lang: "python" label: "Python - Create project skill" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.skills.create(\n display_name=\"summarize_support_ticket\",\n description=\"Summarize support tickets into concise resolution notes.\",\n project_id=\"proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n path=\"/customer-success/skills/summarize-support-ticket\",\n tags=[\"support\", \"summarization\"],\n instructions=(\n \"Read the ticket conversation and return the problem, \"\n \"customer sentiment, and proposed next step.\"\n ),\n)\n\nprint(result.skill.skill_id)\n" - lang: "typescript" label: "Node.js - Create project skill" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.skills.create({\n displayName: 'summarize_support_ticket',\n description: 'Summarize support tickets into concise resolution notes.',\n projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n path: '/customer-success/skills/summarize-support-ticket',\n tags: ['support', 'summarization'],\n instructions:\n 'Read the ticket conversation and return the problem, customer sentiment, and proposed next step.',\n});\n\nconsole.log(result.skill.skillId);\n" security: - ApiKey: [] /v2/skills/{skill_id}: get: tags: - "Skills" summary: "Retrieve a skill" description: "Retrieves an existing skill by skill ID. Display names are also accepted for compatibility because they are unique within a workspace." operationId: "SkillGet" parameters: - name: "skill_id" in: "path" description: "Accepts either the skill's ID (e.g. \"skill_01H...\") or its display\n name. Display names are unique within a workspace." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetSkillResponse" x-speakeasy-group: "skills" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve skill" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/skills/skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Retrieve skill" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.skills.get(\n skill_id=\"skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n\nprint(result.skill.display_name)\n" - lang: "typescript" label: "Node.js - Retrieve skill" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.skills.get({\n skillId: 'skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n\nconsole.log(result.skill.displayName);\n" security: - ApiKey: [] delete: tags: - "Skills" summary: "Delete a skill" description: "Deletes a skill from the workspace. The response body is empty when the delete succeeds." operationId: "SkillDelete" parameters: - name: "skill_id" in: "path" description: "Skill ID to delete." required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteSkillResponse" x-speakeasy-group: "skills" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete skill" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/skills/skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "python" label: "Python - Delete skill" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nclient.skills.delete(\n skill_id=\"skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n)\n" - lang: "typescript" label: "Node.js - Delete skill" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nawait client.skills.delete({\n skillId: 'skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n});\n" security: - ApiKey: [] patch: tags: - "Skills" summary: "Update a skill" description: "Updates mutable skill fields. Omitted optional fields keep their current values. Repeated fields such as `tags` replace the existing collection when provided." operationId: "SkillUpdate" parameters: - name: "skill_id" in: "path" description: "Skill ID to update." required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateSkillRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateSkillResponse" x-speakeasy-group: "skills" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Update skill instructions" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/skills/skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"description\": \"Summarize support tickets for escalation handoff.\",\n \"tags\": [\"support\", \"handoff\"],\n \"instructions\": \"Return the issue summary, urgency, attempted fixes, and recommended owner.\"\n }'\n" - lang: "python" label: "Python - Update skill instructions" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.skills.update(\n skill_id=\"skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n description=\"Summarize support tickets for escalation handoff.\",\n tags=[\"support\", \"handoff\"],\n instructions=(\n \"Return the issue summary, urgency, attempted fixes, \"\n \"and recommended owner.\"\n ),\n)\n\nprint(result.skill.version)\n" - lang: "typescript" label: "Node.js - Update skill instructions" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.skills.update({\n skillId: 'skill_01HZXW2K7Y8Q9M0N1P2R3S4T5V',\n description: 'Summarize support tickets for escalation handoff.',\n tags: ['support', 'handoff'],\n instructions:\n 'Return the issue summary, urgency, attempted fixes, and recommended owner.',\n});\n\nconsole.log(result.skill.version);\n" security: - ApiKey: [] /v2/smart-routers: get: tags: - "Smart Routers" summary: "List Smart Routers" description: "Returns Smart Routers in the caller's workspace, ordered newest first. Supports cursor pagination, name search, profile filtering, and enabled-state filtering." operationId: "SmartRouterList" parameters: - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "starting_after" in: "query" schema: type: "string" - name: "ending_before" in: "query" schema: type: "string" - name: "search" in: "query" schema: type: "string" - name: "profile" in: "query" schema: type: "array" items: $ref: "#/components/schemas/SmartRouterProfile" - name: "enabled" in: "query" schema: type: "boolean" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListSmartRoutersResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List Smart Routers" source: "curl --get 'https://api.orq.ai/v2/smart-routers' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'limit=25'\n" - lang: "typescript" label: "Node.js - List Smart Routers" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nconst page = await client.smartRouters.list({ limit: 25 });\n\nfor (const router of page.data) {\n console.log(router.key, router.profile);\n}\n" security: - ApiKey: [] post: tags: - "Smart Routers" summary: "Create a Smart Router" description: "Creates a workspace Smart Router from an ordered pool of autorouter-eligible models. The router key becomes the stable model identifier used by gateway requests." operationId: "SmartRouterCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSmartRouterRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CreateSmartRouterResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create a Smart Router" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/smart-routers' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"key\": \"production-assistant\",\n \"models\": [\n \"anthropic/claude-opus-4-1\",\n \"anthropic/claude-sonnet-4\",\n \"openai/gpt-4o-mini\"\n ],\n \"profile\": \"SMART_ROUTER_PROFILE_QUALITY\"\n }'\n" - lang: "typescript" label: "Node.js - Create a Smart Router" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nconst result = await client.smartRouters.create({\n key: 'production-assistant',\n models: [\n 'anthropic/claude-opus-4-1',\n 'anthropic/claude-sonnet-4',\n 'openai/gpt-4o-mini',\n ],\n profile: 'SMART_ROUTER_PROFILE_QUALITY',\n});\n\nconsole.log(result.smartRouter.modelRef);\n" security: - ApiKey: [] /v2/smart-routers/{smart_router_id}: get: tags: - "Smart Routers" summary: "Retrieve a Smart Router" description: "Retrieves a Smart Router by ID within the caller's workspace." operationId: "SmartRouterGet" parameters: - name: "smart_router_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetSmartRouterResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve a Smart Router" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/smart-routers/019d-smart-router-id' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "typescript" label: "Node.js - Retrieve a Smart Router" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nconst result = await client.smartRouters.get({\n smartRouterId: '019d-smart-router-id',\n});\n\nconsole.log(result.smartRouter.key);\n" security: - ApiKey: [] delete: tags: - "Smart Routers" summary: "Delete a Smart Router" description: "Permanently deletes a Smart Router and removes its gateway model configuration." operationId: "SmartRouterDelete" parameters: - name: "smart_router_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteSmartRouterResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete a Smart Router" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/smart-routers/019d-smart-router-id' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" - lang: "typescript" label: "Node.js - Delete a Smart Router" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nawait client.smartRouters.delete({\n smartRouterId: '019d-smart-router-id',\n});\n" security: - ApiKey: [] patch: tags: - "Smart Routers" summary: "Update a Smart Router" description: "Partially updates the routing models or profile. The router key is immutable." operationId: "SmartRouterUpdate" parameters: - name: "smart_router_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateSmartRouterRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateSmartRouterResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Update a Smart Router" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/smart-routers/019d-smart-router-id' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\"profile\":\"SMART_ROUTER_PROFILE_COST\"}'\n" - lang: "typescript" label: "Node.js - Update a Smart Router" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nawait client.smartRouters.update({\n smartRouterId: '019d-smart-router-id',\n profile: 'SMART_ROUTER_PROFILE_COST',\n});\n" security: - ApiKey: [] /v2/smart-routers/{smart_router_id}/enabled: post: tags: - "Smart Routers" summary: "Enable or disable a Smart Router" description: "Controls whether the Smart Router is available to gateway requests in the workspace." operationId: "SmartRouterSetEnabled" parameters: - name: "smart_router_id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/SetSmartRouterEnabledRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/SetSmartRouterEnabledResponse" x-speakeasy-group: "smartRouters" x-speakeasy-name-override: "setEnabled" x-code-samples: - lang: "curl" label: "Core - Disable a Smart Router" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/smart-routers/019d-smart-router-id/enabled' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\"enabled\":false}'\n" - lang: "typescript" label: "Node.js - Disable a Smart Router" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({ apiKey: process.env.ORQ_API_KEY });\nawait client.smartRouters.setEnabled({\n smartRouterId: '019d-smart-router-id',\n enabled: false,\n});\n" security: - ApiKey: [] /v2/webhooks: get: tags: - "Webhooks" summary: "List webhooks" description: "Returns a page of webhooks in the current workspace. By default, the first 20 matching webhooks are ordered by creation time, newest first. Supplied filters are combined, `count` reports the total number of matches before pagination, and `has_more` indicates whether another page is available." operationId: "WebhookList" parameters: - name: "page" in: "query" description: "One-based page number. Defaults to 1 and must be between 1 and 1,000,000." schema: type: "integer" format: "int32" - name: "limit" in: "query" description: "Number of webhooks to return per page. Defaults to 20 and must be between\n 1 and 200." schema: type: "integer" format: "int32" - name: "search" in: "query" description: "Optional case-insensitive substring matched against display name, content\n type, and URL. Maximum length is 200 characters." schema: type: "string" - name: "event" in: "query" description: "Optional event slug that must be present in the webhook's event\n subscriptions, for example `llm.response`. Maximum length is 200\n characters." schema: type: "string" - name: "sort" in: "query" description: "Field used to order results. Allowed values are `created`, `updated`, and\n `display_name`. Defaults to `created`." schema: type: "string" - name: "direction" in: "query" description: "Sort direction. Allowed values are `asc` and `desc`. Defaults to `desc`." schema: type: "string" - name: "content_type" in: "query" description: "Optional comma-separated content types to match, for example\n `application/json,application/x-www-form-urlencoded`. A webhook matches\n when its content type equals any supplied value." schema: type: "string" - name: "enabled" in: "query" description: "Optional delivery status filter. When omitted, enabled and disabled\n webhooks are returned." schema: type: "boolean" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListWebhooksResponse" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "list" x-code-samples: - lang: "curl" label: "Core - List filtered webhooks" source: "curl --get 'https://api.orq.ai/v2/webhooks' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --data-urlencode 'search=production' \\\n --data-urlencode 'event=llm.response' \\\n --data-urlencode 'content_type=application/json' \\\n --data-urlencode 'enabled=true' \\\n --data-urlencode 'page=1' \\\n --data-urlencode 'limit=20' \\\n --data-urlencode 'sort=created' \\\n --data-urlencode 'direction=desc'\n" - lang: "python" label: "Python - List filtered webhooks" source: "import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\npage = client.webhooks.list(\n search=\"production\",\n event=\"llm.response\",\n content_type=\"application/json\",\n enabled=True,\n page=1,\n limit=20,\n sort=\"created\",\n direction=\"desc\",\n)\n\nprint(f\"{page.count} matching webhooks\")\nfor webhook in page.items:\n print(webhook._id, webhook.display_name)\nprint(f\"Has more: {page.has_more}\")\n" - lang: "typescript" label: "Node.js - List filtered webhooks" source: "import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst page = await client.webhooks.list({\n search: 'production',\n event: 'llm.response',\n contentType: 'application/json',\n enabled: true,\n page: 1,\n limit: 20,\n sort: 'created',\n direction: 'desc',\n});\n\nconsole.log(`${page.count} matching webhooks`);\nfor (const webhook of page.items) {\n console.log(webhook._id, webhook.displayName);\n}\nconsole.log(`Has more: ${page.hasMore}`);\n" security: - ApiKey: [] post: tags: - "Webhooks" summary: "Create a webhook" description: "Creates a webhook that delivers the selected workspace events to an HTTPS endpoint. Generate a signing secret first with `GET /v2/webhooks/secret`." operationId: "WebhookCreate" requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateWebhookRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/Webhook" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "create" x-code-samples: - lang: "curl" label: "Core - Create webhook" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/webhooks' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"_id\": \"webhook_01HZXW2K7Y8Q9M0N1P2R3S4T5V\",\n \"url\": \"https://example.com/orq-webhook\",\n \"content_type\": \"application/json\",\n \"display_name\": \"Production alerts\",\n \"events\": [\"deployment.invoked\"],\n \"secret\": \"orq_wh_example\",\n \"enabled\": true\n }'\n" security: - ApiKey: [] /v2/webhooks/count: get: tags: - "Webhooks" summary: "Count webhooks" description: "Returns the total number of enabled and disabled webhooks in the current workspace." operationId: "WebhookCount" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/CountWebhooksResponse" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "count" x-code-samples: - lang: "curl" label: "Core - Count webhooks" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/webhooks/count' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" security: - ApiKey: [] /v2/webhooks/query: post: tags: - "Webhooks" summary: "Query webhooks" description: "**Deprecated.** Returns webhooks matching legacy query filters. Use `GET /v2/webhooks` for pagination, search, event filtering, and sorting." operationId: "WebhookQuery" requestBody: content: application/json: schema: $ref: "#/components/schemas/QueryWebhooksRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/QueryWebhooksResponse" deprecated: true x-speakeasy-group: "webhooks" x-speakeasy-name-override: "query" x-code-samples: - lang: "curl" label: "Core - Query webhooks" source: "curl --request POST \\\n --url 'https://api.orq.ai/v2/webhooks/query' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"sortingProps\": [{\"key\": \"created\", \"direction\": \"desc\"}],\n \"filters\": []\n }'\n" security: - ApiKey: [] /v2/webhooks/secret: get: tags: - "Webhooks" summary: "Generate a webhook secret" description: "Generates a signing secret for verifying webhook deliveries. The secret is not persisted until it is used to create or update a webhook; store it securely." operationId: "WebhookGenerateSecret" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GenerateWebhookSecretResponse" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "generateSecret" x-code-samples: - lang: "curl" label: "Core - Generate webhook secret" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/webhooks/secret' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" security: - ApiKey: [] /v2/webhooks/{id}: get: tags: - "Webhooks" summary: "Retrieve a webhook" description: "Retrieves a webhook in the current workspace by ID. The response includes its signing secret; treat it as sensitive." operationId: "WebhookGet" parameters: - name: "id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/Webhook" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "get" x-code-samples: - lang: "curl" label: "Core - Retrieve webhook" source: "curl --request GET \\\n --url 'https://api.orq.ai/v2/webhooks/webhook_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" security: - ApiKey: [] delete: tags: - "Webhooks" summary: "Delete a webhook" description: "Deletes a webhook in the current workspace and returns the deleted webhook ID." operationId: "WebhookDelete" parameters: - name: "id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/DeleteWebhookResponse" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "delete" x-code-samples: - lang: "curl" label: "Core - Delete webhook" source: "curl --request DELETE \\\n --url 'https://api.orq.ai/v2/webhooks/webhook_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY'\n" security: - ApiKey: [] patch: tags: - "Webhooks" summary: "Update a webhook" description: "Updates the supplied fields on a webhook in the current workspace. Omitted fields are unchanged. The response contains the applied fields rather than the complete webhook." operationId: "WebhookUpdate" parameters: - name: "id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: type: "object" required: true responses: "200": description: "OK" content: application/json: schema: type: "object" x-speakeasy-group: "webhooks" x-speakeasy-name-override: "update" x-code-samples: - lang: "curl" label: "Core - Update webhook" source: "curl --request PATCH \\\n --url 'https://api.orq.ai/v2/webhooks/webhook_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \\\n --header 'Authorization: Bearer $ORQ_API_KEY' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"display_name\": \"Updated alerts\",\n \"enabled\": false\n }'\n" security: - ApiKey: [] /v2/workspace-settings: get: tags: - "Workspace Settings" summary: "Retrieve workspace settings" description: "Returns the current settings for the authenticated workspace: its read-only key/slug, display name, the enforce-enabled-models flag, and the workspace-default PII redaction plugin configuration." operationId: "WorkspaceSettingsGet" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetWorkspaceSettingsResponse" x-speakeasy-group: "workspaceSettings" x-speakeasy-name-override: "get" security: - ApiKey: [] patch: tags: - "Workspace Settings" summary: "Update workspace settings" description: "Partially updates workspace settings. Every field is optional; an omitted field is left unchanged. Provide `display_name` to rename the workspace, `enforce_enabled_models` to toggle model enforcement, or `pii_redaction` to replace the workspace-default PII redaction plugin configuration." operationId: "WorkspaceSettingsUpdate" requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateWorkspaceSettingsRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/UpdateWorkspaceSettingsResponse" x-speakeasy-group: "workspaceSettings" x-speakeasy-name-override: "update" security: - ApiKey: [] /v2/router/embeddings: post: description: "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms." operationId: "createEmbedding" requestBody: content: application/json: examples: array_of_strings: summary: "Array of strings input" value: input: - "The food was delicious" - "And the waiter was friendly" model: "openai/text-embedding-3-small" single_string: summary: "Single string input" value: input: "The food was delicious and the waiter..." model: "openai/text-embedding-3-small" schema: additionalProperties: false properties: cache: $ref: "#/components/schemas/EmbeddingCacheConfig" description: "Cache configuration for the request." dimensions: description: "The number of dimensions the resulting output embeddings should have." format: "int64" type: "integer" encoding_format: description: "The format to return the embeddings in. Can be either float or base64." enum: - "float" - "base64" type: "string" fallbacks: description: "Array of fallback models to use if primary model fails." items: $ref: "#/components/schemas/FallbackConfig" type: - "array" - "null" input: anyOf: - description: "A single text string to embed. Must be non-empty." minLength: 1 title: "String" type: "string" - description: "An array of strings or token arrays to embed. Must be non-empty." items: anyOf: - minLength: 1 type: "string" - items: type: "integer" minItems: 1 type: "array" minItems: 1 title: "Array" type: "array" description: "Input text to embed, encoded as a string or array of tokens." load_balancer: $ref: "#/components/schemas/EmbeddingLoadBalancerConfig" description: "Load balancer configuration for the request." model: description: "ID of the model to use." type: "string" name: description: "The name to display on the trace. If not specified, the default system name will be used." type: "string" orq: $ref: "#/components/schemas/EmbeddingOrqParams" description: "Orq platform extension parameters. Top-level equivalents take priority when both are set." retry: $ref: "#/components/schemas/EmbeddingRetryConfig" description: "Retry configuration for the request." timeout: $ref: "#/components/schemas/EmbeddingTimeoutConfig" description: "Timeout configuration to apply to the request." user: description: "A unique identifier representing your end-user." type: "string" required: - "model" - "input" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: data: description: "List of embedding objects." items: $ref: "#/components/schemas/PublicEmbeddingData" minItems: 0 type: - "array" - "null" model: description: "ID of the model used." type: "string" object: description: "Always \"list\"." enum: - "list" type: "string" usage: $ref: "#/components/schemas/PublicEmbeddingUsage" description: "The usage information for the request." required: - "object" - "data" - "model" - "usage" type: "object" description: "Returns the embedding vector." summary: "Create embeddings" tags: - "Embeddings" x-cli-group: "embeddings" x-cli-name: "create" x-orq-gateway-group: true x-speakeasy-group: "router.embeddings" x-speakeasy-name-override: "create" security: - ApiKey: [] /v3/agents/{agent_key}/schedules: get: description: "Lists all schedules attached to the specified agent, most recent first." operationId: "list-agent-schedules" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: schedules: items: $ref: "#/components/schemas/PublicSchedule" type: - "array" - "null" required: - "schedules" type: "object" description: "Schedules listed (empty array if none)." summary: "List schedules" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "list" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "list" security: - ApiKey: [] post: description: "Creates a schedule that runs the agent on a cron cadence. Only `cron` is accepted, as a 6-field expression firing at most once per hour: hourly `0 0 * * * *`, daily `0 0 9 * * *`, or weekly `0 0 9 * * 1`." operationId: "create-agent-schedule" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" requestBody: content: application/json: examples: daily_cron: summary: "Daily at 9am UTC" value: agent_tag: "v2" display_name: "Daily morning briefing" expression: "0 0 9 * * *" payload: input: "Generate the morning briefing for {{region}}" memory_entity_id: "mem_entity_123" metadata: run_source: "daily-briefing" variables: region: "EMEA" type: "cron" hourly_cron: summary: "Every hour (minimum allowed cadence)" value: display_name: "Hourly ticket summary" expression: "0 0 * * * *" payload: input: "Summarize new tickets from the last hour" type: "cron" weekly_cron: summary: "Weekly on Monday at 9am UTC" value: display_name: "Weekly ticket status update" expression: "0 0 9 * * 1" payload: input: "Post the weekly status update for TICKET-123." type: "cron" schema: additionalProperties: false properties: agent_tag: description: "Pin this schedule to a specific agent version. Omit to always use the active version." type: "string" display_name: description: "Human-readable name of the schedule." type: "string" expression: description: "6-field cron expression (sec min hour dom month dow). Seconds and minutes must be 0, day-of-month and month must be '*'. Hour and weekday must each be a single integer or '*'; ranges, lists, steps, and named days are rejected. Accepted shapes: hourly '0 0 * * * *', daily '0 0 9 * * *' (hour 0-23), weekly '0 0 9 * * 1' (weekday 0-6). Minimum firing cadence is 1 hour." type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" description: "Invocation payload delivered to the agent on every firing." type: description: "Schedule type. Only cron is accepted; the expression must be a 6-field cron expression firing at most once per hour." enum: - "cron" type: "string" required: - "type" - "expression" - "display_name" - "payload" type: "object" required: true responses: "201": content: application/json: schema: additionalProperties: false properties: _id: description: "ULID identifying this schedule." type: "string" agent_key: type: "string" agent_tag: description: "Pinned agent version. Omit to always run the agent's current active version." type: "string" created: format: "date-time" type: "string" created_by_id: description: "ID of the API key that created the schedule." type: "string" display_name: description: "Human-readable name of the schedule. Omitted for schedules created before display names were required." type: "string" expression: description: "6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp." type: "string" generation: description: "Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers." format: "int64" type: "integer" is_active: description: "Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing." type: "boolean" last_triggered_at: description: "Timestamp of the most recent firing, if any." format: "date-time" type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" trigger_count: description: "Total firings since creation or last expression/type change." format: "int64" type: "integer" type: description: "Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction." enum: - "cron" - "once" - "interval" type: "string" updated: format: "date-time" type: "string" updated_by_id: description: "ID of the API key that last updated the schedule. Omitted until the schedule is updated." type: "string" required: - "_id" - "agent_key" - "type" - "expression" - "is_active" - "generation" - "payload" - "created_by_id" - "created" - "updated" - "trigger_count" type: "object" description: "Schedule created." "400": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Invalid schedule type, expression, or sub-hour cadence." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Agent (or agent version, when agent_tag is set) not found." summary: "Create schedule" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "create" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "create" security: - ApiKey: [] /v3/agents/{agent_key}/schedules/{schedule_id}: delete: description: "Permanently removes a schedule from NATS, Mongo, and the Redis cache." operationId: "delete-agent-schedule" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" - description: "The schedule's ULID, as returned from create." in: "path" name: "schedule_id" required: true schema: description: "The schedule's ULID, as returned from create." type: "string" responses: "204": description: "Schedule deleted." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Schedule not found, or belongs to a different agent." summary: "Delete schedule" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "delete" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "delete" security: - ApiKey: [] get: description: "Retrieves a single schedule by ID." operationId: "retrieve-agent-schedule" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" - description: "The schedule's ULID, as returned from create." in: "path" name: "schedule_id" required: true schema: description: "The schedule's ULID, as returned from create." type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: _id: description: "ULID identifying this schedule." type: "string" agent_key: type: "string" agent_tag: description: "Pinned agent version. Omit to always run the agent's current active version." type: "string" created: format: "date-time" type: "string" created_by_id: description: "ID of the API key that created the schedule." type: "string" display_name: description: "Human-readable name of the schedule. Omitted for schedules created before display names were required." type: "string" expression: description: "6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp." type: "string" generation: description: "Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers." format: "int64" type: "integer" is_active: description: "Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing." type: "boolean" last_triggered_at: description: "Timestamp of the most recent firing, if any." format: "date-time" type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" trigger_count: description: "Total firings since creation or last expression/type change." format: "int64" type: "integer" type: description: "Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction." enum: - "cron" - "once" - "interval" type: "string" updated: format: "date-time" type: "string" updated_by_id: description: "ID of the API key that last updated the schedule. Omitted until the schedule is updated." type: "string" required: - "_id" - "agent_key" - "type" - "expression" - "is_active" - "generation" - "payload" - "created_by_id" - "created" - "updated" - "trigger_count" type: "object" description: "Schedule retrieved." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Schedule not found, or belongs to a different agent." summary: "Retrieve schedule" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "retrieve" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "retrieve" security: - ApiKey: [] patch: description: "Partially updates a schedule. Any omitted field is left unchanged. Changing `expression` or `type` (or reactivating from inactive) re-publishes the NATS schedule and bumps `generation`; payload-only and `agent_tag`-only changes leave the firing cadence in place." operationId: "update-agent-schedule" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" - description: "The schedule's ULID, as returned from create." in: "path" name: "schedule_id" required: true schema: description: "The schedule's ULID, as returned from create." type: "string" requestBody: content: application/json: examples: change_cadence: summary: "Change the firing time (resets cadence, bumps generation)" value: expression: "0 0 9 * * *" deactivate: summary: "Deactivate a schedule (stops future firings)" value: is_active: false rename: summary: "Rename a schedule" value: display_name: "Nightly report" update_payload: summary: "Update only the payload (keeps firing cadence in place)" value: payload: input: "Updated input for the next run" variables: region: "APAC" schema: additionalProperties: false properties: agent_tag: description: "Change the pinned agent version." type: "string" display_name: description: "Rename the schedule." type: "string" expression: description: "Update the schedule expression. Same 6-field cron shapes as create; minimum firing cadence is 1 hour." type: "string" is_active: description: "Activate or deactivate the schedule. Deactivating removes the NATS entry; activating re-publishes with current values." type: "boolean" payload: $ref: "#/components/schemas/PublicSchedulePayload" description: "Update the invocation payload. Payload-only changes do not reset the firing cadence or bump generation." type: description: "Change the schedule type. Only cron is accepted. Changing type or expression resets the NATS schedule and bumps generation." enum: - "cron" type: "string" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: _id: description: "ULID identifying this schedule." type: "string" agent_key: type: "string" agent_tag: description: "Pinned agent version. Omit to always run the agent's current active version." type: "string" created: format: "date-time" type: "string" created_by_id: description: "ID of the API key that created the schedule." type: "string" display_name: description: "Human-readable name of the schedule. Omitted for schedules created before display names were required." type: "string" expression: description: "6-field cron expression. Schedules stored before the cron-only restriction may also return an @every duration or an @at RFC3339 timestamp." type: "string" generation: description: "Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers." format: "int64" type: "integer" is_active: description: "Whether the schedule is currently firing. Legacy once schedules flip to false automatically after firing." type: "boolean" last_triggered_at: description: "Timestamp of the most recent firing, if any." format: "date-time" type: "string" payload: $ref: "#/components/schemas/PublicSchedulePayload" trigger_count: description: "Total firings since creation or last expression/type change." format: "int64" type: "integer" type: description: "Schedule type. Only cron can be created or updated; once and interval only appear on schedules stored before that restriction." enum: - "cron" - "once" - "interval" type: "string" updated: format: "date-time" type: "string" updated_by_id: description: "ID of the API key that last updated the schedule. Omitted until the schedule is updated." type: "string" required: - "_id" - "agent_key" - "type" - "expression" - "is_active" - "generation" - "payload" - "created_by_id" - "created" - "updated" - "trigger_count" type: "object" description: "Schedule updated." "400": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Invalid type, expression, or sub-hour cadence." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Schedule or agent version not found." summary: "Update schedule" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "update" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "update" security: - ApiKey: [] /v3/agents/{agent_key}/schedules/{schedule_id}/execution: post: description: "Runs the schedule's payload immediately (≈10 seconds after the request, to stay above the NATS scheduler's minimum deliver-at margin). The schedule's regular cadence is unaffected. Inactive schedules return 400." operationId: "trigger-agent-schedule" parameters: - description: "The unique routing key of the agent the schedule belongs to." in: "path" name: "agent_key" required: true schema: description: "The unique routing key of the agent the schedule belongs to." type: "string" - description: "The schedule's ULID, as returned from create." in: "path" name: "schedule_id" required: true schema: description: "The schedule's ULID, as returned from create." type: "string" responses: "202": content: application/json: schema: additionalProperties: false properties: schedule_id: type: "string" status: description: "Always \"triggered\" on success." type: "string" required: - "status" - "schedule_id" type: "object" description: "Execution scheduled for immediate delivery." "400": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Schedule is inactive." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/PublicScheduleErrorDetail" required: - "error" type: "object" description: "Schedule not found, or belongs to a different agent." summary: "Trigger schedule execution" tags: - "Agent Schedules" x-cli-group: "schedules" x-cli-name: "trigger" x-orq-gateway-group: true x-speakeasy-group: "schedules" x-speakeasy-name-override: "trigger" security: - ApiKey: [] /v3/router/models: get: description: "Lists all models available through the AI Router. Returns each model in OpenAI-compatible shape with its provider, ID, and creation timestamp." operationId: "list-models" responses: "200": content: application/json: schema: additionalProperties: false properties: data: description: "Available models." items: $ref: "#/components/schemas/PublicModelEntry" type: - "array" - "null" object: description: "Always \"list\"." enum: - "list" type: "string" required: - "object" - "data" type: "object" description: "Models listed." summary: "List models" tags: - "Models" x-cli-group: "models" x-cli-name: "list" x-orq-gateway-group: true x-speakeasy-group: "models" x-speakeasy-name-override: "list" security: - ApiKey: [] /v3/router/responses: post: description: "Creates a model response for the given input. Returns a response object or a stream of server-sent events." operationId: "create-router-response" requestBody: content: application/json: schema: additionalProperties: false properties: background: description: "If true, the response runs asynchronously in the background." type: "boolean" cache: $ref: "#/components/schemas/CacheConfig" description: "Exact-match response cache configuration for this request." cache_control: description: "Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request." properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" conversation: $ref: "#/components/schemas/ConversationParam" description: "Conversation context for multi-turn interactions." fallbacks: description: "Fallback models to try if the primary model fails. Each entry specifies a model in provider/model format." items: $ref: "#/components/schemas/FallbackConfig" type: - "array" - "null" frequency_penalty: description: "Penalize new tokens based on their frequency in the text so far. Between -2.0 and 2.0." format: "double" type: "number" guardrails: description: "Guardrails to evaluate the request against." items: $ref: "#/components/schemas/EvaluatorRef" type: "array" identity: $ref: "#/components/schemas/ResponseIdentity" description: "Identity/contact information for the end-user." input: anyOf: - description: "A simple text string as input." title: "Text" type: "string" - description: "An array of input items." items: description: "An input item. The \"type\" field determines the item kind: \"message\", \"function_call\", \"function_call_output\", \"item_reference\", etc." properties: arguments: description: "The function arguments as a JSON string (for function_call items)." type: "string" call_id: description: "The function call identifier (for function_call and function_call_output items)." type: "string" content: anyOf: - title: "Text" type: "string" - items: anyOf: - description: "A text content part." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" text: description: "The text content." type: "string" type: enum: - "input_text" type: "string" required: - "type" - "text" title: "Text" type: "object" - description: "An image content part." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" detail: description: "The detail level for image understanding." enum: - "auto" - "low" - "high" type: "string" file_id: description: "The ID of a previously uploaded file." type: "string" image_url: description: "The URL of the image." type: "string" type: enum: - "input_image" type: "string" required: - "type" title: "Image" type: "object" - description: "A file content part. Provide file_id, file_data (base64), or file_url." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" file_data: description: "Base64-encoded file content." type: "string" file_id: description: "The ID of a previously uploaded file." type: "string" file_url: description: "A URL to fetch the file from." type: "string" filename: description: "The name of the file." type: "string" mime_type: description: "The MIME type of the file (e.g., application/pdf)." type: "string" type: enum: - "input_file" type: "string" required: - "type" title: "File" type: "object" description: "A content part within a message." title: "Content parts" type: "array" description: "The content of the item: a string or an array of content parts." id: description: "The ID of the item. For item_reference items, this identifies the referenced item." type: "string" name: description: "The name of the function that was called (for function_call items)." type: "string" output: description: "The output of the function call (for function_call_output type)." type: "string" role: description: "The role of the message sender (for message items)." enum: - "user" - "assistant" - "system" - "developer" type: "string" status: description: "The status of a model-generated input item." enum: - "in_progress" - "completed" - "incomplete" type: "string" type: description: "The type of item." enum: - "message" - "function_call" - "function_call_output" - "item_reference" - "reasoning" - "custom_tool_call" - "custom_tool_call_output" - "computer_call" - "computer_call_output" - "local_shell_call" - "local_shell_call_output" - "shell_call" - "shell_call_output" - "apply_patch_call" - "apply_patch_call_output" - "tool_search_call" - "tool_search_output" - "additional_tools" - "compaction" - "program" - "program_output" - "mcp_call" - "mcp_list_tools" - "mcp_approval_request" - "mcp_approval_response" type: "string" type: "object" title: "Items" type: "array" description: "Input to the model: a string or an array of input items (messages, files, etc.)." instructions: description: "System prompt / instructions for the model." type: "string" integration_id: description: "Integration ID used to resolve provider credentials for this request." type: "string" limits: $ref: "#/components/schemas/ResponseExecutionLimits" description: "Bound agent-loop execution. Fields: max_iterations (LLM turns), max_execution_time (seconds), max_cost (USD; send 0 to disable a manifest-configured cap), max_depth (sub-agent nesting), tool_timeout (seconds). Body values override agent-manifest defaults." load_balancer: $ref: "#/components/schemas/LoadBalancerConfig" description: "Load balancing configuration for selecting among multiple models." max_output_tokens: description: "Maximum number of tokens in the response output." format: "int64" type: "integer" max_tool_calls: description: "Maximum number of tool call rounds in the agentic loop." format: "int64" type: "integer" memory: $ref: "#/components/schemas/MemoryParam" description: "Attach a memory store entity to enable persistent memory across requests. See Memory Stores documentation for setup." metadata: additionalProperties: type: "string" description: "Developer-defined key-value pairs attached to the response (OpenAI spec: Map). Non-string values are rejected with a 400." type: "object" model: description: "The model to use in provider/model format (e.g. openai/gpt-4o). Use agent/ to invoke a pre-configured agent from the orq.ai platform." type: "string" parallel_tool_calls: description: "Whether to allow parallel tool calls." type: "boolean" plugins: description: "Request-scoped transforms applied to the text exchanged with the model. Supports pii_redaction, which replaces PII with placeholders before the provider sees it and restores the original values in the response, and response_healing, which repairs malformed JSON in non-streaming model output." items: $ref: "#/components/schemas/PublicPlugin" type: - "array" - "null" presence_penalty: description: "Penalize new tokens based on their presence in the text so far. Between -2.0 and 2.0." format: "double" type: "number" previous_response_id: description: "The ID of a previous response to continue from. Requires store to be true (default) on the original response." type: "string" prompt_cache_key: description: "Key for prompt caching across requests." type: "string" reasoning: $ref: "#/components/schemas/ReasoningParam" description: "Configure reasoning behavior. Set effort (none, minimal, low, medium, high, xhigh, max) to control how much the model thinks before answering. Higher effort means more reasoning tokens and better answers for complex tasks, at higher cost." retry: $ref: "#/components/schemas/ResponseRetryConfig" description: "Retry configuration. Specify the number of retries and which HTTP status codes should trigger a retry." safety_identifier: description: "Safety identifier for content filtering." type: "string" security: $ref: "#/components/schemas/SecurityConfig" description: "Trace masking configuration for request and response data." service_tier: description: "Processing mode for the request. Fast uses premium low-latency processing; priority remains a backward-compatible alias." enum: - "auto" - "default" - "flex" - "fast" - "scale" - "priority" type: "string" stop_sequences: description: "Custom text sequences that cause the model to stop generating. Forwarded to providers that support it (e.g. Anthropic); ignored otherwise." items: type: "string" type: "array" store: description: "Whether to persist the response (default: true). When false, the response cannot be retrieved later and previous_response_id will not work for follow-up requests." type: "boolean" stream: description: "If true, returns a stream of server-sent events." type: "boolean" stream_options: $ref: "#/components/schemas/StreamOptions" tags: description: "Tags attached to the request trace." items: type: "string" type: - "array" - "null" temperature: description: "Sampling temperature between 0 and 2." format: "double" type: "number" template_engine: description: "Template engine for variable substitution in instructions. Defaults to the agent manifest's engine when invoking an agent, otherwise text." enum: - "text" - "jinja" - "mustache" type: "string" text: description: "Configuration for text output." properties: format: anyOf: - properties: type: enum: - "text" type: "string" required: - "type" title: "Plain text" type: "object" - properties: description: description: "A description of what the response format is for, used by the model to determine how to respond in the format." type: "string" name: description: "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." maxLength: 64 pattern: "^[a-zA-Z0-9_-]+$" type: "string" schema: additionalProperties: true description: "The schema for the response format, described as a JSON Schema object." type: "object" strict: description: "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field." type: "boolean" type: description: "The type of response format being defined. Always `json_schema`." enum: - "json_schema" type: "string" required: - "type" - "name" - "schema" title: "JSON Schema" type: "object" description: "The output format: plain text or structured JSON schema." verbosity: description: "Controls the verbosity of the model output." enum: - "low" - "medium" - "high" type: "string" type: "object" thread: $ref: "#/components/schemas/ResponseThread" description: "Thread for grouping related requests." timeout: $ref: "#/components/schemas/TimeoutConfig" description: "Provider call timeout configuration in milliseconds." tool_choice: anyOf: - description: "Shorthand: \"auto\" lets the model decide, \"none\" disables tools, \"required\" forces tool use." enum: - "auto" - "none" - "required" title: "Shorthand" type: "string" - description: "Select a specific function tool by name." properties: name: description: "The name of the function to call." type: "string" type: enum: - "function" type: "string" required: - "type" - "name" title: "Specific function" type: "object" description: "How the model should use the provided tools. Can be a string shorthand or a specific function selector." tools: description: "Tools available to the model." items: anyOf: - description: "A function tool the model can call." properties: cache_control: properties: ttl: default: "5m" description: "The time-to-live for the cache control breakpoint. This may be one of the following values:\n\n- `5m`: 5 minutes\n- `1h`: 1 hour\n\nDefaults to `5m`. Only supported by Anthropic Claude models." enum: - "5m" - "1h" type: "string" type: description: "Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"." enum: - "ephemeral" type: "string" required: - "type" title: "Cache control" type: "object" description: description: "A description of what the function does." type: "string" name: description: "The name of the function." type: "string" parameters: additionalProperties: true description: "The parameters the function accepts, as a JSON Schema object." type: "object" strict: description: "Whether to enforce strict parameter validation." type: "boolean" type: enum: - "function" type: "string" required: - "type" - "name" title: "Function" type: "object" - $ref: "#/components/schemas/OrqAdvisorTool" - $ref: "#/components/schemas/OrqSidekickTool" - description: "An orq.ai platform tool reference. For MCP tools, prefer type 'mcp' with 'key' instead of 'orq:mcp' with 'tool_id'." properties: files: description: "Files to stage in /workspace for orq:code_interpreter. Maximum 10 files." items: properties: file_id: description: "The workspace file ID." type: "string" name: description: "The file name exposed under /workspace." type: "string" required: - "file_id" - "name" type: "object" maxItems: 10 type: "array" network: description: "Network access intent for orq:code_interpreter. Stored and validated today; runtime enforcement by the sandbox egress layer is rolling out and until then sandbox executions retain default public internet egress." properties: allowlist: default: [] description: "Allowed network hostnames or IPv4 addresses when mode is allowlist. Maximum 50 entries." items: type: "string" maxItems: 50 type: "array" mode: default: "disabled" description: "Network mode. Defaults to disabled." enum: - "disabled" - "allowlist" type: "string" type: "object" tool_id: description: "The tool ID (for orq:mcp, orq:http, orq:function)." type: "string" type: description: "The orq.ai tool type." enum: - "orq:current_date" - "orq:google_search" - "orq:web_scraper" - "orq:code_interpreter" - "orq:mcp" - "orq:http" - "orq:function" type: "string" required: - "type" title: "orq.ai Tool" type: "object" - description: "An MCP (Model Context Protocol) server tool. Provide server_url for inline mode, or key to reference a pre-configured MCP server." properties: allowed_tools: description: "Filter which tools from the MCP server are exposed." properties: read_only: description: "Only expose tools with readOnlyHint annotation." type: "boolean" tool_names: description: "List of allowed tool names." items: type: "string" type: "array" type: "object" headers: additionalProperties: type: "string" description: "Custom headers to send with MCP requests. Values support {{variable}} templates." type: "object" key: description: "Unique identifier. Required for pre-configured MCP servers (lookup key). For inline servers, used as a trace/display label." type: "string" server_description: description: "Human-readable description of the server." type: "string" server_url: description: "The MCP server endpoint URL (inline mode)." type: "string" type: enum: - "mcp" type: "string" required: - "type" title: "MCP Tool" type: "object" description: "A tool definition. The \"type\" field determines the tool kind." type: "array" top_k: description: "Only sample from the top K options for each subsequent token. Forwarded to providers that support it (e.g. Anthropic); ignored otherwise." format: "int64" type: "integer" top_logprobs: description: "Number of most likely tokens to return at each position." format: "int64" type: "integer" top_p: description: "Nucleus sampling parameter." format: "double" type: "number" variables: additionalProperties: {} description: "Template variables for prompt substitution. Plain values fill {{variable}} placeholders in instructions. For secrets, use {\"secret\": true, \"value\": \"sensitive-data\"} — secrets are automatically passed to platform tools (Python, HTTP, MCP) and redacted from traces." type: "object" type: "object" required: true responses: "200": content: application/json: schema: additionalProperties: false properties: background: type: "boolean" completed_at: format: "int64" type: - "integer" - "null" conversation: $ref: "#/components/schemas/ConversationParam" created_at: format: "int64" type: "integer" error: anyOf: - $ref: "#/components/schemas/ResponseError" - type: "null" frequency_penalty: format: "double" type: "number" id: type: "string" incomplete_details: anyOf: - $ref: "#/components/schemas/IncompleteDetails" - type: "null" input: description: "Array of input items (messages, function call outputs, etc.)" items: {} type: - "array" - "null" instructions: type: - "string" - "null" max_output_tokens: format: "int64" type: - "integer" - "null" max_tool_calls: format: "int64" type: - "integer" - "null" memory: $ref: "#/components/schemas/MemoryParam" metadata: additionalProperties: type: "string" description: "Developer-defined key-value pairs attached to the response (OpenAI spec: Map)." type: "object" model: type: "string" object: description: "Always \"response\"" type: "string" output: description: "Array of output items (messages, function calls, reasoning, etc.)" items: {} type: - "array" - "null" parallel_tool_calls: type: "boolean" presence_penalty: format: "double" type: "number" previous_response_id: type: - "string" - "null" prompt_cache_key: type: - "string" - "null" prompt_cache_retention: type: - "string" - "null" reasoning: anyOf: - $ref: "#/components/schemas/Reasoning" - type: "null" safety_identifier: type: - "string" - "null" service_tier: enum: - "auto" - "default" - "flex" - "fast" - "scale" - "priority" type: "string" status: enum: - "queued" - "in_progress" - "completed" - "failed" - "incomplete" type: "string" store: type: "boolean" telemetry: $ref: "#/components/schemas/Telemetry" description: "OpenTelemetry trace and span identifiers for this response." temperature: format: "double" type: "number" text: description: "Text output configuration including format and verbosity" tool_choice: description: "Tool choice setting: \"auto\", \"none\", \"required\", or a specific function" tools: description: "Array of tool configurations used in this response" items: {} type: - "array" - "null" top_k: description: "Only sample from the top K options for each subsequent token. Present only when set on the request." format: "int64" type: "integer" top_logprobs: format: "int64" type: "integer" top_p: format: "double" type: "number" truncation: enum: - "disabled" - "auto" type: "string" usage: anyOf: - $ref: "#/components/schemas/PublicUsage" - type: "null" user: type: - "string" - "null" variables: additionalProperties: {} type: "object" required: - "id" - "object" - "created_at" - "completed_at" - "status" - "incomplete_details" - "model" - "previous_response_id" - "instructions" - "input" - "output" - "error" - "tools" - "tool_choice" - "temperature" - "top_p" - "presence_penalty" - "frequency_penalty" - "top_logprobs" - "max_output_tokens" - "max_tool_calls" - "reasoning" - "text" - "user" - "usage" - "truncation" - "parallel_tool_calls" - "store" - "background" - "metadata" - "service_tier" - "safety_identifier" - "prompt_cache_key" - "prompt_cache_retention" type: "object" text/event-stream: schema: type: object properties: data: $ref: "#/components/schemas/ResponseStreamEvent" x-speakeasy-sse-sentinel: "[DONE]" description: "Returns a response object or a stream of events." summary: "Create response" tags: - "Responses" x-cli-group: "responses" x-cli-name: "create" x-orq-gateway-group: true x-speakeasy-group: "responses" x-speakeasy-name-override: "create" security: - ApiKey: [] /v3/router/responses/{response_id}: get: description: "Retrieves a previously created response by its ID." operationId: "retrieve-response" parameters: - description: "The ID of the response to retrieve" in: "path" name: "response_id" required: true schema: description: "The ID of the response to retrieve" type: "string" responses: "200": content: application/json: schema: additionalProperties: false properties: background: type: "boolean" completed_at: format: "int64" type: - "integer" - "null" conversation: $ref: "#/components/schemas/ConversationParam" created_at: format: "int64" type: "integer" error: anyOf: - $ref: "#/components/schemas/ResponseError" - type: "null" frequency_penalty: format: "double" type: "number" id: type: "string" incomplete_details: anyOf: - $ref: "#/components/schemas/IncompleteDetails" - type: "null" input: description: "Array of input items (messages, function call outputs, etc.)" items: {} type: - "array" - "null" instructions: type: - "string" - "null" max_output_tokens: format: "int64" type: - "integer" - "null" max_tool_calls: format: "int64" type: - "integer" - "null" memory: $ref: "#/components/schemas/MemoryParam" metadata: additionalProperties: type: "string" description: "Developer-defined key-value pairs attached to the response (OpenAI spec: Map)." type: "object" model: type: "string" object: description: "Always \"response\"" type: "string" output: description: "Array of output items (messages, function calls, reasoning, etc.)" items: {} type: - "array" - "null" parallel_tool_calls: type: "boolean" presence_penalty: format: "double" type: "number" previous_response_id: type: - "string" - "null" prompt_cache_key: type: - "string" - "null" prompt_cache_retention: type: - "string" - "null" reasoning: anyOf: - $ref: "#/components/schemas/Reasoning" - type: "null" safety_identifier: type: - "string" - "null" service_tier: enum: - "auto" - "default" - "flex" - "fast" - "scale" - "priority" type: "string" status: enum: - "queued" - "in_progress" - "completed" - "failed" - "incomplete" type: "string" store: type: "boolean" telemetry: $ref: "#/components/schemas/Telemetry" description: "OpenTelemetry trace and span identifiers for this response." temperature: format: "double" type: "number" text: description: "Text output configuration including format and verbosity" tool_choice: description: "Tool choice setting: \"auto\", \"none\", \"required\", or a specific function" tools: description: "Array of tool configurations used in this response" items: {} type: - "array" - "null" top_k: description: "Only sample from the top K options for each subsequent token. Present only when set on the request." format: "int64" type: "integer" top_logprobs: format: "int64" type: "integer" top_p: format: "double" type: "number" truncation: enum: - "disabled" - "auto" type: "string" usage: anyOf: - $ref: "#/components/schemas/PublicUsage" - type: "null" user: type: - "string" - "null" variables: additionalProperties: {} type: "object" required: - "id" - "object" - "created_at" - "completed_at" - "status" - "incomplete_details" - "model" - "previous_response_id" - "instructions" - "input" - "output" - "error" - "tools" - "tool_choice" - "temperature" - "top_p" - "presence_penalty" - "frequency_penalty" - "top_logprobs" - "max_output_tokens" - "max_tool_calls" - "reasoning" - "text" - "user" - "usage" - "truncation" - "parallel_tool_calls" - "store" - "background" - "metadata" - "service_tier" - "safety_identifier" - "prompt_cache_key" - "prompt_cache_retention" type: "object" description: "Response retrieved successfully." "404": content: application/json: schema: additionalProperties: false properties: error: $ref: "#/components/schemas/APIError" required: - "error" type: "object" description: "Response not found." summary: "Retrieve response" tags: - "Responses" x-cli-group: "responses" x-cli-name: "get" x-orq-gateway-group: true x-speakeasy-group: "responses" x-speakeasy-name-override: "get" security: - ApiKey: [] /v3/logs/aggregate: post: tags: - "Logs" summary: "Aggregate logs" description: "Return severity counts grouped by time buckets at a configurable grain (auto, minute, hour, day)." operationId: "AggregateLogs" requestBody: content: application/json: schema: $ref: "#/components/schemas/AggregateLogsRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/AggregateLogsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "aggregate" security: - ApiKey: [] /v3/logs/facets: get: tags: - "Logs" summary: "List log facets" description: "Return the facet hierarchy: attribute families (native, attribute, resource, scope) with their keys, counts, and top values for the requested time range." operationId: "ListLogFacets" parameters: - name: "from" in: "query" schema: type: "string" format: "date-time" - name: "to" in: "query" schema: type: "string" format: "date-time" - name: "key_limit" in: "query" schema: type: "integer" format: "int32" - name: "value_limit" in: "query" schema: type: "integer" format: "int32" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListLogFacetsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "listFacets" security: - ApiKey: [] /v3/logs/facets/{field}: get: tags: - "Logs" summary: "List facet values" description: "Return distinct values with occurrence counts for a given facet field." operationId: "ListLogFacetValues" parameters: - name: "field" in: "path" required: true schema: type: "string" - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "from" in: "query" schema: type: "string" format: "date-time" - name: "to" in: "query" schema: type: "string" format: "date-time" - name: "search" in: "query" description: "Optional case-insensitive substring search over facet values." schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListLogFacetValuesResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "listFacetValues" security: - ApiKey: [] /v3/logs/fields: get: tags: - "Logs" summary: "List log fields" description: "Return all queryable fields: static columns and dynamic attribute families (attribute.*, resource.*)." operationId: "ListLogFields" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListLogFieldsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "listFields" security: - ApiKey: [] /v3/logs/patterns: post: tags: - "Logs" summary: "Find log patterns" description: "Find stable templates in a bounded sample of matching log bodies. The response reports sampling and truncation metadata and never returns an unbounded list of raw bodies." operationId: "FindLogPatterns" requestBody: content: application/json: schema: $ref: "#/components/schemas/FindLogPatternsRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/FindLogPatternsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "findPatterns" security: - ApiKey: [] /v3/logs/query: post: tags: - "Logs" summary: "Query logs with OQL" description: "Run an OQL log query using the pipeline grammar `fetch logs | filter | sort timestamp desc | limit N`. The query is compiled onto the same engine as SearchLogs; timestamp desc is the only supported sort." operationId: "QueryLogs" requestBody: content: application/json: schema: $ref: "#/components/schemas/QueryLogsRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/QueryLogsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "query" security: - ApiKey: [] /v3/logs/search: post: tags: - "Logs" summary: "Search logs" description: "Query log records with filters, free-text search, and keyset pagination. Results are ordered timestamp desc (the only supported sort, mirroring traces)." operationId: "SearchLogs" requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchLogsRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/SearchLogsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "search" security: - ApiKey: [] /v3/logs/{id}: get: tags: - "Logs" summary: "Get a single log" description: "Retrieve a log record by its ULID. Returns 404 if the record does not exist or belongs to another workspace." operationId: "GetLog" parameters: - name: "id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetLogResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "get" security: - ApiKey: [] /v3/logs/{id}/context: post: tags: - "Logs" summary: "Get surrounding log context" description: "Retrieve the matching log records immediately before and after an anchor log. Neighbors use the same free-text and structured filter dialect as SearchLogs and are returned in chronological order." operationId: "GetLogContext" parameters: - name: "id" in: "path" required: true schema: type: "string" requestBody: content: application/json: schema: $ref: "#/components/schemas/GetLogContextRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetLogContextResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "context" security: - ApiKey: [] /v3/traces/{trace_id}/logs: get: tags: - "Logs" summary: "List logs for a trace" description: "Return all log records correlated with a given trace_id. Results are scoped to the authenticated workspace." operationId: "ListTraceLogs" parameters: - name: "trace_id" in: "path" required: true schema: type: "string" - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "page_token" in: "query" schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListTraceLogsResponse" x-speakeasy-group: "logs" x-speakeasy-name-override: "listTraceLogs" security: - ApiKey: [] /v2/reporting: post: tags: - "Reporting" summary: "Query reporting metrics" description: "Returns time-series, scalar, and top-list analytics for AI usage, cost, latency, evaluator results, and guardrail outcomes. This API remains supported while the neutral telemetry envelope is proven against every reporting request shape." operationId: "ReportingQuery" requestBody: content: application/json: schema: $ref: "#/components/schemas/QueryReportRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/QueryReportResponse" x-speakeasy-group: "reporting" x-speakeasy-name-override: "query" security: - ApiKey: [] /v3/traces/aggregate: post: tags: - "Traces" summary: "Aggregate traces" description: "Aggregate trace metrics using the structured trace filter contract. This API remains supported; POST /v3/telemetry/query offers the same aggregate shape in a neutral multi-signal envelope." operationId: "TracesAggregate" requestBody: content: application/json: schema: $ref: "#/components/schemas/AggregateTracesRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/AggregateTracesResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "aggregate" security: - ApiKey: [] /v3/traces/facets: get: tags: - "Traces" summary: "List trace facets" description: "List trace fields that support facet value discovery." operationId: "TracesListFacets" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListTraceFacetsResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "list_facets" security: - ApiKey: [] /v3/traces/facets/{field}: get: tags: - "Traces" summary: "List trace facet values" description: "List values and counts for one trace facet field." operationId: "TracesListFacetValues" parameters: - name: "field" in: "path" required: true schema: type: "string" - name: "from" in: "query" schema: type: "string" format: "date-time" - name: "to" in: "query" schema: type: "string" format: "date-time" - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "filter_operator" in: "query" schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListTraceFacetValuesResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "list_facet_values" security: - ApiKey: [] /v3/traces/fields: get: tags: - "Traces" summary: "List trace fields" description: "List currently supported static trace fields." operationId: "TracesListFields" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListTraceFieldsResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "list_fields" security: - ApiKey: [] /v3/traces/query: post: tags: - "Traces" summary: "Query traces with OQL" description: "Run an OQL trace query. OQL is validated against the trace field registry and compiled through the trace planner." operationId: "TracesQueryOql" requestBody: content: application/json: schema: $ref: "#/components/schemas/QueryTracesRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/QueryTracesResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "query" security: - ApiKey: [] /v3/traces/search: post: tags: - "Traces" summary: "Search traces" description: "Search trace summaries using the structured trace filter contract." operationId: "TracesSearch" requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchTracesRequest" required: true responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/SearchTracesResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "search" security: - ApiKey: [] /v3/traces/{trace_id}: get: tags: - "Traces" summary: "Get trace" description: "Retrieve one trace summary by trace id." operationId: "TracesGet" parameters: - name: "trace_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetTraceResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "get" security: - ApiKey: [] /v3/traces/{trace_id}/spans: get: tags: - "Traces" summary: "List trace spans" description: "List canonical span summaries for a trace." operationId: "TracesListSpans" parameters: - name: "trace_id" in: "path" required: true schema: type: "string" - name: "limit" in: "query" schema: type: "integer" format: "int32" - name: "page_token" in: "query" schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/ListTraceSpansResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "list_spans" security: - ApiKey: [] /v3/traces/{trace_id}/spans/{span_id}: get: tags: - "Traces" summary: "Get trace span" description: "Retrieve one hydrated span." operationId: "TracesGetSpan" parameters: - name: "trace_id" in: "path" required: true schema: type: "string" - name: "span_id" in: "path" required: true schema: type: "string" responses: "200": description: "OK" content: application/json: schema: $ref: "#/components/schemas/GetTraceSpanResponse" x-speakeasy-group: "traces" x-speakeasy-name-override: "get_span" security: - ApiKey: [] webhooks: {} tags: - description: "List models available through the AI Router." name: "Models" - name: "Guardrail Rules" - name: "Policies" - name: "Routing Rules" - name: "Activities" description: "Activity timeline entries for comments and entity versions." - 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: "API keys" description: "API keys authenticate programmatic access to the workspace. The unified key model exposes opaque tokens, per-domain access grants, and budget / rate-limit constraints (see ADR 0001 and ADR 0002)." - name: "Budgets" description: "Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, api-key, provider, and model. A budget is hierarchical and defense-in-depth — every applicable budget is a hard gate, and the most restrictive one wins per dimension (see ADR 0007)." - name: "Documentation" description: "Search the orq.ai documentation. Proxies the workspace's query to the hosted docs search index." - name: "FeaturePreviews" description: "Internal: list and toggle per-user feature previews (beta features users can opt into)." - name: "Files" description: "File upload and retrieval operations." - name: "Finder" description: "Finder entities back the studio navigation tree, project switcher, and cross-project resource references." - 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: "Model Sharing" description: "Model sharing controls which projects a workspace model is available to. Workspace admins configure a model's Sharing (all projects / selected projects); the config ships inline on the models list response, so there is no separate read endpoint." - name: "Notifiers" description: "Notifier destinations used to send delivery and workflow notifications." - name: "People" description: "People are workspace members and invited users. Manage roles, groups, and invitations for your team." - name: "Projects" description: "Projects organize resources within a workspace" - name: "Skills" description: "Skills are modular instructions you can use to codify processes and conventions" - name: "Smart Routers" description: "Smart Routers distribute an ordered pool of eligible language models across V2 routing bands." - name: "Webhooks" description: "Create and manage webhooks that deliver workspace events to external HTTPS endpoints." - 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: "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."