Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• filterstring

  Optional model name. Returns only models whose name matches it exactly or as a dated snapshot, ordered from the closest match.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• filterstring

  Optional model name. Returns only models whose name matches it exactly or as a dated snapshot, ordered from the closest match.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• Sse-Stream-Options

  Optional. Use no-ping to disable periodic keep-alive events on streaming responses.

Request parameters:

• $.modelstringRequired

  Integrated model name, AI Gateway identifier or AI Gateway slug.

• $.messagesarray

  OpenAI-compatible message array. Required unless prompt is supplied.

  Examples:

  User text content

  User message with textual content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "Describe these inputs briefly."
                  }
              ]
          },
          {
              "role": "user",
              "content": "Alternative, short way to input data"
          }
      ]
  }

  Assistant message

  Assistant message with textual content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "assistant",
              "content": "How can I help you today?"
          }
      ]
  }

  System message

  System message with instructions for the assistant

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "system",
              "content": "Answer concisely and in English."
          },
          {
              "role": "user",
              "content": "What is the capital of France?"
          }
      ]
  }

  Tool call result

  Assistant tool call followed by its tool result

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "assistant",
              "content": null,
              "tool_calls": [
                  {
                      "id": "call_weather_123",
                      "type": "function",
                      "function": {
                          "name": "get_weather",
                          "arguments": "{\"city\":\"Lisbon\",\"unit\":\"celsius\"}"
                      }
                  }
              ]
          },
          {
              "role": "tool",
              "tool_call_id": "call_weather_123",
              "content": "{\"temperature\":21,\"unit\":\"celsius\",\"condition\":\"sunny\"}"
          }
      ]
  }

  User image content

  User message with textual and image content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What's on this image?"
                  },
                  {
                      "type": "image_url",
                      "image_url": {
                          "url": "data:image/png;base64,SGVsbG8sIHdvcmxkIQ==",
                          "detail": "auto"
                      }
                  },
                  {
                      "type": "image_url",
                      "image_url": {
                          "url": "https://example.com/image.png",
                          "detail": "high"
                      }
                  }
              ]
          }
      ]
  }

  User audio content

  User message with textual and audio content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "Transcribe the following audio."
                  },
                  {
                      "type": "input_audio",
                      "input_audio": {
                          "data": "VGhpcyBpcyBhIHRlc3Qu...",
                          "format": "wav"
                      }
                  }
              ]
          }
      ]
  }

  User video content

  User message with textual and video content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What happens in the following video?"
                  },
                  {
                      "type": "video_url",
                      "video_url": {
                          "url": "UHJvZ3JhbWFjYW8gZW0gSmF2YQ=="
                      }
                  },
                  {
                      "type": "video_url",
                      "video_url": {
                          "url": "https://example.com/video.mp4"
                      }
                  }
              ]
          }
      ]
  }

  User file/PDF content

  User message with textual and file content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What's the insights of this report?"
                  },
                  {
                      "type": "file",
                      "file": {
                          "filename": "document.pdf",
                          "file_data": "data:application/pdf;base64,QmFzZTY0IGVuY29kaW5nIGV4YW1wbGU="
                      }
                  },
                  {
                      "type": "file",
                      "file": {
                          "filename": "document.pdf",
                          "file_data": "https://example.com/report.pdf"
                      }
                  }
              ]
          }
      ]
  }

• $.promptstring | array

  Alias for $.messages. String or OpenAI-compatible message array accepted as an alternative to messages.

• $.streamboolean

  Streams completion events as text/event-stream when true.

• $.metadataobject

  Optional string key/value metadata stored with the conversation.

• $.idempotency_keystring

  Optional key used to reuse the the observability conversation token. Use one id for the each conversation.

• $.allow_loggingboolean

  Optional. When false, this request is not written to the account conversation logs. Defaults to true; account-level conversation logging still applies.

• $.userstring

  Optional external user identifier.

• $.temperaturenumber

  Optional sampling temperature.

• $.top_pnumber

  Optional nucleus sampling value.

• $.top_kinteger

  Optional top-k sampling value forwarded to compatible gateways.

• $.seedinteger

  Optional sampling seed.

• $.toolsarray

  Optional OpenAI-compatible tool definitions.

  Examples:

  Weather tool

  Function tool that retrieves the current weather for a city

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "What is the current weather in Lisbon?"
          }
      ],
      "tools": [
          {
              "type": "function",
              "function": {
                  "name": "get_weather",
                  "description": "Gets the current weather for a city.",
                  "parameters": {
                      "type": "object",
                      "properties": {
                          "city": {
                              "type": "string",
                              "description": "City name."
                          },
                          "unit": {
                              "type": "string",
                              "enum": [ "celsius", "fahrenheit" ]
                          }
                      },
                      "required": [ "city" ],
                      "additionalProperties": false
                  }
              }
          }
      ]
  }

• $.tool_choicestring | object

  Optional tool-selection behavior forwarded to compatible gateways.

• $.builtin_toolsobject

  Optional AIVAX built-in tool selection and options. Include DateTime in tools to expose get_date_time, which takes no arguments and returns date, time, day_of_week (English), time_zone, utc_offset and date_time (ISO 8601).

  Examples:

  Web search and image generation

  AIVAX built-in tools for searching the web and generating an image from the findings

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "Search the web for a recent James Webb Space Telescope discovery, summarize it, and generate an illustration inspired by the findings."
          }
      ],
      "builtin_tools": {
          "tools": [ "WebSearch", "ImageGeneration" ],
          "options": {
              "webSearchMode": "Full",
              "webSearchMaxResults": 5,
              "imageGenerationMaxResults": 1,
              "imageGenerationQuality": "High",
              "imageGenerationAllowMatureContent": false,
              "imageGenerationAllowReferenceUsage": true
          }
      }
  }

• $.time_zonestring

  Optional IANA time zone, such as America/Sao_Paulo, used by get_date_time, scheduling tools and the Bash tool for this request only. Overrides the AI gateway time zone, which defaults to America/Sao_Paulo. Invalid identifiers are rejected.

• $.routing_optionsobject

  Optional provider routing for integrated models. Overrides the gateway routing preference for this request only.

  Examples:

  Preferred providers with fallback

  Tries azure-us, then azure-eu, then any available provider, choosing within each step with the Balanced strategy

  {
      "model": "@openai/gpt-6-luna",
      "messages": [
          {
              "role": "user",
              "content": "Summarize this incident report."
          }
      ],
      "routing_options": {
          "preset": "Balanced",
          "allowed_providers": [ "azure/us", "azure/eu", "*" ]
      }
  }

• $.routing_options.presetstring

  Provider routing strategy: Balanced, Cheapest, Fastest or Quality. Defaults to the gateway routing preference.

• $.routing_options.allowed_providersarray

  Ordered provider tags tried in sequence, such as azure-us. Use "" to match any provider, usually as the last item. Defaults to [""]; an empty array is rejected. The request fails when none of the listed providers is available.

• $.routing_presetstring

  Deprecated. Use routing_options.preset instead. When both are sent, routing_options.preset takes precedence.

• $.reasoning_effortstring

  Optional reasoning effort selector.

• $.verbositystring

  Optional response verbosity selector.

• $.max_completion_tokensinteger

  Optional maximum completion tokens.

• $.max_tokensinteger

  Compatibility alias for max_completion_tokens.

• $.stopstring | array

  Optional stop sequence or sequences.

• $.response_formatobject

  Optional OpenAI-compatible structured-output format.

• $.response_schemaobject

  Optional shorthand JSON schema for structured output.

  Examples:

  JSON healing after a tool call

  Tool result followed by a schema-constrained final response with automatic JSON healing

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "What is the current weather in Lisbon?"
          }
      ],
      "tools": [
          {
              "type": "function",
              "function": {
                  "name": "get_weather",
                  "description": "Gets the current weather for a city.",
                  "parameters": {
                      "type": "object",
                      "properties": {
                          "city": {
                              "type": "string"
                          },
                          "unit": {
                              "type": "string",
                              "enum": [ "celsius", "fahrenheit" ]
                          }
                      },
                      "required": [ "city" ],
                      "additionalProperties": false
                  }
              }
          }
      ],
      "response_schema": {
          "type": "object",
          "properties": {
              "city": {
                  "type": "string"
              },
              "temperature": {
                  "type": "number"
              },
              "unit": {
                  "type": "string",
                  "enum": [ "celsius", "fahrenheit" ]
              },
              "condition": {
                  "type": "string"
              }
          },
          "required": [ "city", "temperature", "unit", "condition" ],
          "additionalProperties": false
      }
  }

• $.extra_bodyobject

  Optional provider-specific request fields; supported only with AI Gateways with BYOK.

• $.service_tierstring

  Optional provider service tier; supported only with AI Gateways with BYOK.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• Sse-Stream-Options

  Optional. Use no-ping to disable periodic keep-alive events on streaming responses.

Request parameters:

• $.modelstringRequired

  Integrated model name, AI Gateway identifier or AI Gateway slug.

• $.messagesarray

  OpenAI-compatible message array. Required unless prompt is supplied.

  Examples:

  User text content

  User message with textual content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "Describe these inputs briefly."
                  }
              ]
          },
          {
              "role": "user",
              "content": "Alternative, short way to input data"
          }
      ]
  }

  Assistant message

  Assistant message with textual content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "assistant",
              "content": "How can I help you today?"
          }
      ]
  }

  System message

  System message with instructions for the assistant

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "system",
              "content": "Answer concisely and in English."
          },
          {
              "role": "user",
              "content": "What is the capital of France?"
          }
      ]
  }

  Tool call result

  Assistant tool call followed by its tool result

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "assistant",
              "content": null,
              "tool_calls": [
                  {
                      "id": "call_weather_123",
                      "type": "function",
                      "function": {
                          "name": "get_weather",
                          "arguments": "{\"city\":\"Lisbon\",\"unit\":\"celsius\"}"
                      }
                  }
              ]
          },
          {
              "role": "tool",
              "tool_call_id": "call_weather_123",
              "content": "{\"temperature\":21,\"unit\":\"celsius\",\"condition\":\"sunny\"}"
          }
      ]
  }

  User image content

  User message with textual and image content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What's on this image?"
                  },
                  {
                      "type": "image_url",
                      "image_url": {
                          "url": "data:image/png;base64,SGVsbG8sIHdvcmxkIQ==",
                          "detail": "auto"
                      }
                  },
                  {
                      "type": "image_url",
                      "image_url": {
                          "url": "https://example.com/image.png",
                          "detail": "high"
                      }
                  }
              ]
          }
      ]
  }

  User audio content

  User message with textual and audio content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "Transcribe the following audio."
                  },
                  {
                      "type": "input_audio",
                      "input_audio": {
                          "data": "VGhpcyBpcyBhIHRlc3Qu...",
                          "format": "wav"
                      }
                  }
              ]
          }
      ]
  }

  User video content

  User message with textual and video content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What happens in the following video?"
                  },
                  {
                      "type": "video_url",
                      "video_url": {
                          "url": "UHJvZ3JhbWFjYW8gZW0gSmF2YQ=="
                      }
                  },
                  {
                      "type": "video_url",
                      "video_url": {
                          "url": "https://example.com/video.mp4"
                      }
                  }
              ]
          }
      ]
  }

  User file/PDF content

  User message with textual and file content

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": [
                  {
                      "type": "text",
                      "text": "What's the insights of this report?"
                  },
                  {
                      "type": "file",
                      "file": {
                          "filename": "document.pdf",
                          "file_data": "data:application/pdf;base64,QmFzZTY0IGVuY29kaW5nIGV4YW1wbGU="
                      }
                  },
                  {
                      "type": "file",
                      "file": {
                          "filename": "document.pdf",
                          "file_data": "https://example.com/report.pdf"
                      }
                  }
              ]
          }
      ]
  }

• $.promptstring | array

  Alias for $.messages. String or OpenAI-compatible message array accepted as an alternative to messages.

• $.streamboolean

  Streams completion events as text/event-stream when true.

• $.metadataobject

  Optional string key/value metadata stored with the conversation.

• $.idempotency_keystring

  Optional key used to reuse the the observability conversation token. Use one id for the each conversation.

• $.allow_loggingboolean

  Optional. When false, this request is not written to the account conversation logs. Defaults to true; account-level conversation logging still applies.

• $.userstring

  Optional external user identifier.

• $.temperaturenumber

  Optional sampling temperature.

• $.top_pnumber

  Optional nucleus sampling value.

• $.top_kinteger

  Optional top-k sampling value forwarded to compatible gateways.

• $.seedinteger

  Optional sampling seed.

• $.toolsarray

  Optional OpenAI-compatible tool definitions.

  Examples:

  Weather tool

  Function tool that retrieves the current weather for a city

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "What is the current weather in Lisbon?"
          }
      ],
      "tools": [
          {
              "type": "function",
              "function": {
                  "name": "get_weather",
                  "description": "Gets the current weather for a city.",
                  "parameters": {
                      "type": "object",
                      "properties": {
                          "city": {
                              "type": "string",
                              "description": "City name."
                          },
                          "unit": {
                              "type": "string",
                              "enum": [ "celsius", "fahrenheit" ]
                          }
                      },
                      "required": [ "city" ],
                      "additionalProperties": false
                  }
              }
          }
      ]
  }

• $.tool_choicestring | object

  Optional tool-selection behavior forwarded to compatible gateways.

• $.builtin_toolsobject

  Optional AIVAX built-in tool selection and options. Include DateTime in tools to expose get_date_time, which takes no arguments and returns date, time, day_of_week (English), time_zone, utc_offset and date_time (ISO 8601).

  Examples:

  Web search and image generation

  AIVAX built-in tools for searching the web and generating an image from the findings

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "Search the web for a recent James Webb Space Telescope discovery, summarize it, and generate an illustration inspired by the findings."
          }
      ],
      "builtin_tools": {
          "tools": [ "WebSearch", "ImageGeneration" ],
          "options": {
              "webSearchMode": "Full",
              "webSearchMaxResults": 5,
              "imageGenerationMaxResults": 1,
              "imageGenerationQuality": "High",
              "imageGenerationAllowMatureContent": false,
              "imageGenerationAllowReferenceUsage": true
          }
      }
  }

• $.time_zonestring

  Optional IANA time zone, such as America/Sao_Paulo, used by get_date_time, scheduling tools and the Bash tool for this request only. Overrides the AI gateway time zone, which defaults to America/Sao_Paulo. Invalid identifiers are rejected.

• $.routing_optionsobject

  Optional provider routing for integrated models. Overrides the gateway routing preference for this request only.

  Examples:

  Preferred providers with fallback

  Tries azure-us, then azure-eu, then any available provider, choosing within each step with the Balanced strategy

  {
      "model": "@openai/gpt-6-luna",
      "messages": [
          {
              "role": "user",
              "content": "Summarize this incident report."
          }
      ],
      "routing_options": {
          "preset": "Balanced",
          "allowed_providers": [ "azure/us", "azure/eu", "*" ]
      }
  }

• $.routing_options.presetstring

  Provider routing strategy: Balanced, Cheapest, Fastest or Quality. Defaults to the gateway routing preference.

• $.routing_options.allowed_providersarray

  Ordered provider tags tried in sequence, such as azure-us. Use "" to match any provider, usually as the last item. Defaults to [""]; an empty array is rejected. The request fails when none of the listed providers is available.

• $.routing_presetstring

  Deprecated. Use routing_options.preset instead. When both are sent, routing_options.preset takes precedence.

• $.reasoning_effortstring

  Optional reasoning effort selector.

• $.verbositystring

  Optional response verbosity selector.

• $.max_completion_tokensinteger

  Optional maximum completion tokens.

• $.max_tokensinteger

  Compatibility alias for max_completion_tokens.

• $.stopstring | array

  Optional stop sequence or sequences.

• $.response_formatobject

  Optional OpenAI-compatible structured-output format.

• $.response_schemaobject

  Optional shorthand JSON schema for structured output.

  Examples:

  JSON healing after a tool call

  Tool result followed by a schema-constrained final response with automatic JSON healing

  {
      "model": "@google/gemini-3-flash",
      "messages": [
          {
              "role": "user",
              "content": "What is the current weather in Lisbon?"
          }
      ],
      "tools": [
          {
              "type": "function",
              "function": {
                  "name": "get_weather",
                  "description": "Gets the current weather for a city.",
                  "parameters": {
                      "type": "object",
                      "properties": {
                          "city": {
                              "type": "string"
                          },
                          "unit": {
                              "type": "string",
                              "enum": [ "celsius", "fahrenheit" ]
                          }
                      },
                      "required": [ "city" ],
                      "additionalProperties": false
                  }
              }
          }
      ],
      "response_schema": {
          "type": "object",
          "properties": {
              "city": {
                  "type": "string"
              },
              "temperature": {
                  "type": "number"
              },
              "unit": {
                  "type": "string",
                  "enum": [ "celsius", "fahrenheit" ]
              },
              "condition": {
                  "type": "string"
              }
          },
          "required": [ "city", "temperature", "unit", "condition" ],
          "additionalProperties": false
      }
  }

• $.extra_bodyobject

  Optional provider-specific request fields; supported only with AI Gateways with BYOK.

• $.service_tierstring

  Optional provider service tier; supported only with AI Gateways with BYOK.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that contains the documents.

Query parameters:

• filterstring

  Plain text search across name, reference, contents and tags, or command syntax such as -t tag -n name -r reference -c content -i id.

• order_bystring

  Sort order: created_at_asce, created_at_desc, updated_at_asce, updated_at_desc, indexed_at_asce or indexed_at_desc.

• statestring

  Indexing state filter. Accepted values: queued or indexed.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that will receive the documents.

Request parameters:

• documentsfile

  JSONL file containing one document object per line.

  Examples:

  JSONL document file

  File contents with one document JSON object per line.

  {"docId":"getting-started","text":"Open the dashboard and create your first collection.","__ref":"https://example.com/docs/getting-started","__tags":["guide","onboarding"],"__meta":{"language":"en"}}
  {"docId":"pricing","text":"Plans are billed monthly and can be changed at any time.","__tags":["billing"]}

• insert-modestring

  Set to sync to delete collection documents whose names are not present in the uploaded JSONL file.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that contains or will receive the document.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that will receive the documents.

Query parameters:

• insert-modestring

  Set to sync to delete collection documents whose names are not present in the streamed lines after END is received.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Import-Media-File-NameRequired

  Original media file name. Required for the import.

• X-Import-Media-File-Name-Encoding

  Set to percent when X-Import-Media-File-Name is percent-encoded.

• X-Import-Media-Upload-IdRequired

  UUID that identifies this upload and must also be sent when completing it.

Path parameters:

• collection-iduuid

  Identifier of the collection that will receive the imported document.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that contains the document.

• document-iduuid

  Identifier of the document to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that contains the document.

• document-iduuid

  Identifier of the document to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Import-Media-File-NameRequired

  Original media file name used for the completed import.

• X-Import-Media-File-Name-Encoding

  Set to percent when X-Import-Media-File-Name is percent-encoded.

• X-Import-Media-Upload-IdRequired

  UUID that identifies the chunks to process.

Path parameters:

• collection-iduuid

  Identifier of the collection that will receive the imported document.

Request parameters:

• $.contextstring

  Optional context used while processing the imported media.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.contentsarrayRequired

  Non-empty URL or base64 data URI values to extract.

  Examples:

  Web pages

  Extracts readable content from public web pages.

  {
      "contents": [
          "https://example.com/article",
          "https://example.org/documentation"
      ],
      "returnErrors": true
  }

  Inline files (data url)

  Extracts an inline file supplied as a base64 data URI with its MIME type. This example encodes a plain-text file containing Hello world.

  {
      "contents": [
          "data:text/plain;base64,SGVsbG8gd29ybGQ="
      ],
      "returnErrors": true
  }

  External files

  Extracts content from direct public file URLs. Replace the example URLs with accessible files in supported formats.

  {
      "contents": [
          "https://example.com/files/manual.pdf",
          "https://example.com/files/receipt.png",
          "https://example.com/files/report.docx"
      ],
      "returnErrors": true
  }

• $.returnErrorsboolean

  Defaults to true: returns an error item for each failed extraction or JSON conversion. When false, failed items are omitted.

• $.responseSchemaobject

  Optional JSON Schema applied to each item's extracted text to generate extractedObject. Omit or set to null for text-only extraction. JSON conversion usage is reported separately in jsonProcessingUnits.

  Examples:

  Structured JSON extraction

  Extracts receipt fields into JSON while retaining the source text. JSON conversion has a separate inference-based PU charge.

  {
      "contents": [
          "https://example.com/files/receipt.png"
      ],
      "returnErrors": true,
      "responseSchema": {
          "type": "object",
          "instructions": "Extract only information present in the receipt. Use null for missing values.",
          "properties": {
              "merchant": {
                  "type": ["string", "null"],
                  "description": "Merchant name printed on the receipt."
              },
              "date": {
                  "type": ["string", "null"],
                  "description": "Receipt date in YYYY-MM-DD format, if available."
              },
              "total": {
                  "type": ["number", "null"],
                  "description": "Final total printed on the receipt."
              }
          },
          "required": ["merchant", "date", "total"],
          "additionalProperties": false
      }
  }

• $.responseSchema.instructionsstring

  Optional extraction guidance inside responseSchema. This AIVAX extension is not a standard JSON Schema keyword.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.querystringRequired

  Search query.

• $.topninteger

  Optional result count from 1 to 25.

• $.countrystring

  Optional two-letter ISO 3166-1 country code.

• $.languagestring

  Optional language code.

• $.includeDomainsarray

  Optional domain allowlist.

  Examples:

  Domain allowlist

  Restricts results to the supplied domains.

  {
      "query": "latest artificial intelligence research",
      "topn": 5,
      "country": "US",
      "language": "en",
      "includeDomains": [
          "arxiv.org",
          "nature.com"
      ]
  }

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• web-chat-iduuid

  Identifier of the web chat client.

Query parameters:

• external-user-idstring

  Optional external user id used to restrict schedules and recurring tasks.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• web-chat-iduuid

  Identifier of the web chat client.

• iduuid

  Identifier of the one-time schedule.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• web-chat-iduuid

  Identifier of the web chat client.

• iduuid

  Identifier of the schedule to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• web-chat-iduuid

  Identifier of the web chat client.

• iduuid

  Identifier of the recurring task.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• web-chat-iduuid

  Identifier of the web chat client.

• iduuid

  Identifier of the recurring task to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the web chat client to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the web chat client to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the web chat client to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the web chat client whose integration will be updated.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the web chat client.

• namestring

  Integration name to remove: Zapi, Telegram, EvolutionApi or Kapso.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• chat-client-iduuid

  Identifier of the web chat client that owns the session.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• chat-client-iduuid

  Identifier of the web chat client whose sessions will be listed.

Query parameters:

• filterstring

  Optional search over access key, extra context, external user id or exact session id.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• chat-client-iduuid

  Identifier of the web chat client that owns the session.

• session-iduuid

  Identifier of the session to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• filterstring

  Optional search over skill id, slug or description.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• skill-iduuid

  Identifier of the skill to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• skill-iduuid

  Identifier of the skill to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• skill-iduuid

  Identifier of the skill to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• skillsfile

  JSONL file containing one skill object per line.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  File path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  Destination file path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  File path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  Directory path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  Directory path to create inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  Directory path inside the shell sandbox. Root paths are rejected.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  File path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

• X-Shell-User-IdRequired

  Application user identifier used to isolate this shell filesystem within the authenticated account.

Query parameters:

• pathstringRequired

  File path inside the shell sandbox.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.collectionsarrayRequired

  Collection UUIDs to search.

• $.termsstring | array

  Search string or strings. Optional when a filter is supplied: without terms, only filtered documents are returned, newest first, without embedding or reranking.

• $.termstring | array

  Compatibility alias for terms.

• $.promptstring | array

  Compatibility alias for terms.

• $.topinteger

  Optional maximum number of results.

• $.minScorenumber

  Optional minimum similarity score.

• $.rerankerstring

  Optional reranker identifier.

• $.filterstring | array

  Optional document filter evaluated before the search. Example: 'tags has "finance" and metadata.year >= 2025 and createdAt >= now-30d'. An array of filters is combined with and. Syntax and examples: https://docs.aivax.net/docs/filters/document-filters

• $.includeReferencesboolean

  Includes referenced document chunks when true.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.collectionsarrayRequired

  Collection UUIDs to search.

• $.termsstring | array

  Search string or strings. Optional when a filter is supplied: without terms, only filtered documents are returned, newest first, without embedding or reranking.

• $.termstring | array

  Compatibility alias for terms.

• $.promptstring | array

  Compatibility alias for terms.

• $.topinteger

  Optional maximum number of results.

• $.minScorenumber

  Optional minimum similarity score.

• $.rerankerstring

  Optional reranker identifier.

• $.filterstring | array

  Optional document filter evaluated before the search. Example: 'tags has "finance" and metadata.year >= 2025 and createdAt >= now-30d'. An array of filters is combined with and. Syntax and examples: https://docs.aivax.net/docs/filters/document-filters

• $.includeReferencesboolean

  Includes referenced document chunks when true.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.documentsarrayRequired

  Non-empty document strings to rank.

• $.querystringRequired

  Query used to rank the documents.

• $.modelstring

  Optional reranker identifier.

• $.top_ninteger

  Optional maximum number of ranked documents to return.

• $.min_scorenumber

  Optional minimum relevance score.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.documentsarrayRequired

  Non-empty document strings to segment.

• $.sanitizeboolean

  Optional text sanitization flag. Skip possible segments or documents that are better left out of the RAG. Sanitized requests are processed by a language model and are slower.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.documentsarrayRequired

  Non-empty document strings to rank.

• $.querystringRequired

  Query used to rank the documents.

• $.modelstring

  Optional reranker identifier.

• $.top_ninteger

  Optional maximum number of ranked documents to return.

• $.min_scorenumber

  Optional minimum relevance score.

Path parameters:

• access-keystring

  Access key of the public chat-client session.

Request parameters:

• $.promptstring | object | arrayRequired

  Text (converted to a user message), one OpenAI-compatible message, or an ordered array of messages. At least one message must contain content or tool calls. Messages are added after the existing session history for inference.

  Examples:

  Multimodal prompt

  User prompt containing text and an image URL.

  {
      "prompt": {
          "role": "user",
          "content": [
              {
                  "type": "text",
                  "text": "Describe this image."
              },
              {
                  "type": "image_url",
                  "image_url": {
                      "url": "https://example.com/image.png",
                      "detail": "auto"
                  }
              }
          ]
      }
  }

• $.prompt.rolestring

  For message objects, use user for user input, assistant for tool-call messages, or tool for tool results. Also applies to each message in an array.

• $.prompt.contentstring | array

  Message text or OpenAI-compatible multimodal content parts. For tool results, provide the result as text. Also applies to each message in an array.

• $.prompt.tool_callsarray

  OpenAI-compatible tool calls on an assistant message, with id, type=function and function containing name and JSON-encoded arguments.

• $.prompt.tool_call_idstring

  For a tool result, the matching assistant tool-call identifier. Also applies to each message in an array.

• $.prompt.namestring

  Function name for a tool result. Also applies to each message in an array.

• $.commitboolean

  Defaults to true. Saves submitted and generated messages to the session. Set false to run against the existing history without saving this turn. Inference usage and tool side effects still occur; this is not a dry run.

• $.instructionsstring | array

  Additional context for this inference only, appended after the session context and fetched external context. An array of strings is joined with blank lines. Does not replace or persist as the session extraContext.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• monthstring

  Reporting month in YYYY-MM format.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• searchstring

  Optional case-insensitive test-name search.

• gatewaystring

  Optional exact gateway identifier, slug, or integrated model name.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.namestringRequired

  Human-readable test name. Maximum length: 200 characters.

• $.gatewaystringRequired

  AI Gateway slug, gateway identifier, or integrated model name to test. Maximum length: 200 characters.

• $.goalstring | object | arrayRequired

  Goal pursued by the simulated user and evaluated by the judge. Accepts text, one multimodal message part, or an array of message parts.

• $.validation_criteriastring | object | array | null

  Additional success criteria visible only to the judge. Accepts text, one multimodal message part, or an array of message parts. Defaults to null.

• $.startarray

  Initial OpenAI-compatible conversation messages supplied before simulation begins. Defaults to an empty array.

• $.max_turnsinteger

  Maximum simulated user turns, from 2 to 64. Defaults to 10.

• $.minimum_turnsinteger

  First turn on which the simulated user may end the conversation, from 1 to max_turns - 1. Defaults to 1.

• $.allow_user_exitboolean

  Whether the simulated user may end the conversation after minimum_turns. Defaults to true.

• $.judge_start_turninteger

  First turn evaluated by the judge, from 1 to max_turns - 1. Defaults to 1.

• $.loss_thresholdnumber

  Score below which consecutive judge evaluations contribute to failure, from 0.01 to 0.99. Must be more than 0.1 below base_threshold. Defaults to 0.2.

• $.base_thresholdnumber

  Score at or above which the goal is achieved, from 0.01 to 0.99. Must be more than 0.1 above loss_threshold. Defaults to 0.9.

• $.profilestring

  Simulator and judge model profile: low, medium, or high. Defaults to medium.

• $.user_samplingobject

  Optional simulated-user sampling configuration.

• $.user_sampling.top_knumber

  Maximum option-selection range used by the simulated-user sampler, from 0 to 2. Defaults to 0.4.

• $.user_sampling.max_decaynumber

  Maximum probability decay used by the simulated-user sampler, from 0 to 1. Defaults to 0.02.

• $.metadataobject

  String key/value metadata forwarded to gateway inference. Defaults to an empty object.

• $.resourcesarray

  External context resources. Accepts at most 16 items and defaults to an empty array.

  Examples:

  Inline context for internal evaluation

  Resolves inline text once at run startup and exposes it only to the simulated user and judge.

  [
      {
          "type": "Text",
          "hook": "OnStart",
          "visibility": "Internal",
          "cacheDuration": 900,
          "data": "The customer has a 14-day refund window."
      }
  ]

  Fresh remote context for the gateway

  Fetches the URL before every turn, bypasses cache, and exposes the result only to the tested gateway.

  [
      {
          "type": "RemoteResource",
          "hook": "OnTurn",
          "visibility": "Gateway",
          "cacheDuration": 0,
          "data": "https://example.com/current-inventory"
      }
  ]

  Shared cached remote context

  Fetches the URL at run startup and exposes the result to the simulated user, judge, and tested gateway. The remote response may be reused for up to six hours.

  [
      {
          "type": "RemoteResource",
          "hook": "OnStart",
          "visibility": "Both",
          "cacheDuration": 21600,
          "data": "https://example.com/refund-policy"
      }
  ]

• $.resources[].typestring

  Resource source: Text for inline content or RemoteResource for an HTTP or HTTPS URL. Defaults to Text.

• $.resources[].hookstring

  Resolution lifecycle: OnStart resolves once when the run starts; OnTurn resolves once before each turn. Defaults to OnStart.

• $.resources[].visibilitystring

  Recipients: Internal exposes the resource only to the simulated user and judge; Gateway exposes it only to the tested gateway; Both exposes it to all three. Defaults to Internal.

• $.resources[].cacheDurationinteger

  Remote-resource cache duration in seconds, from 0 to 21600. Zero disables caching between resolutions. Defaults to 900.

• $.resources[].datastring

  Required non-empty inline text or remote HTTP/HTTPS URL, according to type.

• $.external_user_idstring | null

  Optional external user identifier forwarded to gateway usage and conversation attribution. Maximum length: 200 characters. Defaults to null.

• $.hooksarray

  Validation callbacks for persisted runs. Accepts at most 16 items and defaults to an empty array.

• $.hooks[].eventstring

  Required callback event: before-test, after-test, before-inference, after-inference, or context-changed. before-inference and after-inference require an AI Gateway rather than an integrated model.

• $.hooks[].urlstring

  Required public HTTP or HTTPS callback URL. Local and private addresses are rejected. Maximum length: 2048 characters.

• $.cronstring | null

  Optional standard five-field cron expression. Consecutive occurrences must be at least five minutes apart. Defaults to null.

• $.enabledboolean

  Whether scheduled runs are enabled. Defaults to true.

• $.notification_thresholdinteger

  Consecutive failed runs required before a failure notification is created. Minimum: 1. Defaults to 1.

• $.recovery_notificationboolean

  Whether a successful run after failures creates a recovery notification. Defaults to true.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

Request parameters:

• $.namestring

  Replacement human-readable test name. Maximum length: 200 characters.

• $.gatewaystring

  Replacement AI Gateway slug, gateway identifier, or integrated model name. Maximum length: 200 characters.

• $.goalstring | object | array

  Replacement goal pursued by the simulated user and evaluated by the judge.

• $.validation_criteriastring | object | array

  Replacement criteria visible only to the judge.

• $.startarray

  Replacement initial OpenAI-compatible conversation messages.

• $.max_turnsinteger

  Replacement maximum simulated user turns, from 2 to 64.

• $.minimum_turnsinteger

  Replacement first turn on which the simulated user may exit, from 1 to max_turns - 1.

• $.allow_user_exitboolean

  Replacement setting controlling whether the simulated user may exit after minimum_turns.

• $.judge_start_turninteger

  Replacement first turn evaluated by the judge, from 1 to max_turns - 1.

• $.loss_thresholdnumber

  Replacement loss threshold, from 0.01 to 0.99 and more than 0.1 below base_threshold.

• $.base_thresholdnumber

  Replacement success threshold, from 0.01 to 0.99 and more than 0.1 above loss_threshold.

• $.profilestring

  Replacement simulator and judge model profile: low, medium, or high.

• $.user_samplingobject

  Replacement simulated-user sampling configuration.

• $.user_sampling.top_knumber

  Maximum option-selection range from 0 to 2.

• $.user_sampling.max_decaynumber

  Maximum probability decay from 0 to 1.

• $.metadataobject

  Replacement string key/value metadata forwarded to gateway inference.

• $.resourcesarray

  Replacement list of external context resources. Accepts at most 16 items; supplying it replaces the complete list.

  Examples:

  Replace with inline and remote resources

  Replaces the complete resource list with one internal startup context and one gateway-only per-turn URL.

  [
      {
          "type": "Text",
          "hook": "OnStart",
          "visibility": "Internal",
          "cacheDuration": 900,
          "data": "The customer is eligible for priority support."
      },
      {
          "type": "RemoteResource",
          "hook": "OnTurn",
          "visibility": "Gateway",
          "cacheDuration": 0,
          "data": "https://example.com/current-account-state"
      }
  ]

• $.resources[].typestring

  Resource source: Text or RemoteResource. Defaults to Text when omitted from an item.

• $.resources[].hookstring

  Resolution lifecycle: OnStart or OnTurn. Defaults to OnStart when omitted from an item.

• $.resources[].visibilitystring

  Recipients: Internal, Gateway, or Both. Defaults to Internal when omitted from an item.

• $.resources[].cacheDurationinteger

  Remote-resource cache duration in seconds, from 0 to 21600. Zero disables caching between resolutions. Defaults to 900 when omitted from an item.

• $.resources[].datastring

  Required non-empty inline text or remote HTTP/HTTPS URL, according to type.

• $.external_user_idstring

  Replacement external user identifier forwarded to gateway usage and conversation attribution. Maximum length: 200 characters.

• $.hooksarray

  Replacement validation callback list. Accepts at most 16 items.

• $.hooks[].eventstring

  Required callback event: before-test, after-test, before-inference, after-inference, or context-changed. before-inference and after-inference require an AI Gateway rather than an integrated model.

• $.hooks[].urlstring

  Required public HTTP or HTTPS callback URL. Local and private addresses are rejected.

• $.cronstring | null

  Replacement standard five-field cron expression. Consecutive occurrences must be at least five minutes apart; null disables scheduling.

• $.enabledboolean

  Replacement scheduled-run enabled state.

• $.notification_thresholdinteger

  Replacement consecutive-failure notification threshold. Minimum: 1.

• $.recovery_notificationboolean

  Replacement recovery-notification setting.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.modelstringRequired

  AI Gateway slug, gateway identifier, or integrated model name to test.

• $.goalstring | object | arrayRequired

  Goal pursued by the simulated user and evaluated by the judge. Accepts text, one multimodal message part, or an array of message parts.

• $.validation_criteriastring | object | array | null

  Additional success criteria visible only to the judge. Defaults to null.

• $.startarray

  Initial OpenAI-compatible conversation messages supplied before simulation begins. Defaults to an empty array.

  Examples:

  Initial conversation

  Starts the evaluation with an existing OpenAI-compatible conversation.

  {
      "model": "checkout-gateway",
      "goal": "Complete checkout successfully",
      "start": [
          {
              "role": "assistant",
              "content": "Welcome. How can I help with your order?"
          },
          {
              "role": "user",
              "content": "I want to complete checkout for the items in my cart."
          }
      ]
  }

• $.max_turnsinteger

  Maximum simulated user turns, from 2 to 64. Defaults to 10.

• $.minimum_turnsinteger

  First turn on which the simulated user may end the conversation, from 1 to max_turns - 1. Defaults to 1.

• $.allow_user_exitboolean

  Whether the simulated user may end the conversation after minimum_turns. Defaults to true.

• $.judge_start_turninteger

  First turn evaluated by the judge, from 1 to max_turns - 1. Defaults to 1.

• $.loss_thresholdnumber

  Score below which consecutive judge evaluations contribute to failure, from 0.01 to 0.99. Must be more than 0.1 below base_threshold. Defaults to 0.2.

• $.base_thresholdnumber

  Score at or above which the goal is achieved, from 0.01 to 0.99. Must be more than 0.1 above loss_threshold. Defaults to 0.9.

• $.metadataobject

  String key/value metadata forwarded to gateway inference. Defaults to an empty object.

• $.resourcesarray

  Optional external context resources. Accepts at most 16 items.

  Examples:

  Inline context for internal evaluation

  Resolves inline text once when the evaluation starts and exposes it only to the simulated user and judge.

  [
      {
          "type": "Text",
          "hook": "OnStart",
          "visibility": "Internal",
          "cacheDuration": 900,
          "data": "The customer has a 14-day refund window."
      }
  ]

  Fresh remote context for the gateway

  Fetches the URL before every turn, bypasses cache, and exposes the result only to the tested gateway.

  [
      {
          "type": "RemoteResource",
          "hook": "OnTurn",
          "visibility": "Gateway",
          "cacheDuration": 0,
          "data": "https://example.com/current-inventory"
      }
  ]

  Shared cached remote context

  Fetches the URL once at evaluation startup and exposes the result to all inference participants with a six-hour cache.

  [
      {
          "type": "RemoteResource",
          "hook": "OnStart",
          "visibility": "Both",
          "cacheDuration": 21600,
          "data": "https://example.com/refund-policy"
      }
  ]

• $.resources[].typestring

  Resource source: Text for inline content or RemoteResource for an HTTP or HTTPS URL. Defaults to Text.

• $.resources[].hookstring

  Resolution lifecycle: OnStart resolves once when the evaluation starts; OnTurn resolves once before each turn. Defaults to OnStart.

• $.resources[].visibilitystring

  Recipients: Internal exposes the resource only to the simulated user and judge; Gateway exposes it only to the tested gateway; Both exposes it to all three. Defaults to Internal.

• $.resources[].cacheDurationinteger

  Remote-resource cache duration in seconds, from 0 to 21600. Zero disables caching between resolutions. Defaults to 900.

• $.resources[].datastring

  Required non-empty inline text or remote HTTP/HTTPS URL, according to type.

• $.profilestring

  Simulator and judge model profile: low, medium, or high. Defaults to medium.

• $.external_user_idstring | null

  External user identifier forwarded to gateway usage and conversation attribution. Maximum length: 200 characters. Defaults to null.

• $.userstring | null

  Compatibility alias used only when external_user_id is omitted.

• $.streamboolean

  Accepted for OpenAI compatibility; this endpoint always streams server-sent events regardless of the supplied value.

• $.user_samplingobject

  Simulated-user sampling configuration.

• $.user_sampling.top_knumber

  Maximum option-selection range used by the simulated-user sampler, from 0 to 2. Defaults to 0.4.

• $.user_sampling.max_decaynumber

  Maximum probability decay used by the simulated-user sampler, from 0 to 1. Defaults to 0.02.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

Query parameters:

• statestring

  Optional run-state filter: pending, running, succeeded, failed, or cancelled.

• limitinteger

  Maximum number of runs to return. Defaults to 50 and is capped at 100.

• offsetinteger

  Number of runs to skip. Defaults to zero.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.modelstringRequired

  AI Gateway slug, gateway identifier, or integrated model name to test.

• $.goalstring | object | arrayRequired

  Goal pursued by the simulated user and evaluated by the judge. Accepts text, one multimodal message part, or an array of message parts.

• $.validation_criteriastring | object | array | null

  Additional success criteria visible only to the judge. Defaults to null.

• $.startarray

  Initial OpenAI-compatible conversation messages supplied before simulation begins. Defaults to an empty array.

  Examples:

  Initial conversation

  Starts the evaluation with an existing OpenAI-compatible conversation.

  {
      "model": "checkout-gateway",
      "goal": "Complete checkout successfully",
      "start": [
          {
              "role": "assistant",
              "content": "Welcome. How can I help with your order?"
          },
          {
              "role": "user",
              "content": "I want to complete checkout for the items in my cart."
          }
      ]
  }

• $.max_turnsinteger

  Maximum simulated user turns, from 2 to 64. Defaults to 10.

• $.minimum_turnsinteger

  First turn on which the simulated user may end the conversation, from 1 to max_turns - 1. Defaults to 1.

• $.allow_user_exitboolean

  Whether the simulated user may end the conversation after minimum_turns. Defaults to true.

• $.judge_start_turninteger

  First turn evaluated by the judge, from 1 to max_turns - 1. Defaults to 1.

• $.loss_thresholdnumber

  Score below which consecutive judge evaluations contribute to failure, from 0.01 to 0.99. Must be more than 0.1 below base_threshold. Defaults to 0.2.

• $.base_thresholdnumber

  Score at or above which the goal is achieved, from 0.01 to 0.99. Must be more than 0.1 above loss_threshold. Defaults to 0.9.

• $.metadataobject

  String key/value metadata forwarded to gateway inference. Defaults to an empty object.

• $.resourcesarray

  Optional external context resources. Accepts at most 16 items.

  Examples:

  Inline context for internal evaluation

  Resolves inline text once when the evaluation starts and exposes it only to the simulated user and judge.

  [
      {
          "type": "Text",
          "hook": "OnStart",
          "visibility": "Internal",
          "cacheDuration": 900,
          "data": "The customer has a 14-day refund window."
      }
  ]

  Fresh remote context for the gateway

  Fetches the URL before every turn, bypasses cache, and exposes the result only to the tested gateway.

  [
      {
          "type": "RemoteResource",
          "hook": "OnTurn",
          "visibility": "Gateway",
          "cacheDuration": 0,
          "data": "https://example.com/current-inventory"
      }
  ]

  Shared cached remote context

  Fetches the URL once at evaluation startup and exposes the result to all inference participants with a six-hour cache.

  [
      {
          "type": "RemoteResource",
          "hook": "OnStart",
          "visibility": "Both",
          "cacheDuration": 21600,
          "data": "https://example.com/refund-policy"
      }
  ]

• $.resources[].typestring

  Resource source: Text for inline content or RemoteResource for an HTTP or HTTPS URL. Defaults to Text.

• $.resources[].hookstring

  Resolution lifecycle: OnStart resolves once when the evaluation starts; OnTurn resolves once before each turn. Defaults to OnStart.

• $.resources[].visibilitystring

  Recipients: Internal exposes the resource only to the simulated user and judge; Gateway exposes it only to the tested gateway; Both exposes it to all three. Defaults to Internal.

• $.resources[].cacheDurationinteger

  Remote-resource cache duration in seconds, from 0 to 21600. Zero disables caching between resolutions. Defaults to 900.

• $.resources[].datastring

  Required non-empty inline text or remote HTTP/HTTPS URL, according to type.

• $.profilestring

  Simulator and judge model profile: low, medium, or high. Defaults to medium.

• $.external_user_idstring | null

  External user identifier forwarded to gateway usage and conversation attribution. Maximum length: 200 characters. Defaults to null.

• $.userstring | null

  Compatibility alias used only when external_user_id is omitted.

• $.streamboolean

  Accepted for OpenAI compatibility; this endpoint always streams server-sent events regardless of the supplied value.

• $.user_samplingobject

  Simulated-user sampling configuration.

• $.user_sampling.top_knumber

  Maximum option-selection range used by the simulated-user sampler, from 0 to 2. Defaults to 0.4.

• $.user_sampling.max_decaynumber

  Maximum probability decay used by the simulated-user sampler, from 0 to 1. Defaults to 0.02.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

• run-iduuid

  Run identifier.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Agentic Test identifier.

• run-iduuid

  Run identifier.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.inputstring | arrayRequired

  Prompt string or non-empty prompt string array.

  Examples:

  Multiple prompts

  Generates images for each prompt in the input array.

  {
      "input": [
          "A kitten playing with a ball",
          "A lighthouse during a winter storm"
      ],
      "count": 1,
      "model": "wan-image-2.7-pro"
  }

• $.countinteger

  Optional number of images per prompt, from 1 to 4.

• $.modelstringRequired

  Image model identifier.

• $.referenceImagesarray

  Optional HTTP(S) reference image URLs.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.documentsarrayRequired

  Non-empty document strings to classify.

• $.labelsarrayRequired

  Non-empty labels to score against every document.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.modelstringRequired

  Semantic model identifier, such as typesafe/jev-1.13.

• $.stateanyRequired

  JSON value evaluated by all questions, such as a string, array, object, number, boolean, or null. Image-capable models also accept image parts directly in a top-level array, next to plain-string text items: { "type": "image_url", "image_url": { "url": "data:image/png;base64,..." } }. Only base64 data URLs of type image/png, image/jpeg, or image/webp are accepted, and images nested inside objects are not read.

• $.questionsobjectRequired

  Non-empty object keyed by question name. Each question requires type, instructions, and criteria. Noul criteria require true/false strings; choice criteria map choice names to strings; score criteria are an ordered array of level descriptions.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.videosarrayRequired

  OpenAI-compatible video_url content parts.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.inputarrayRequired

  OpenAI-compatible multimodal content parts to describe.

  Examples:

  Image URL

  Describes an image from an HTTP(S) URL.

  {
      "extractionGuidance": "Identify the main subject and visible text.",
      "input": [
          {
              "type": "image_url",
              "image_url": {
                  "url": "https://example.com/image.png",
                  "detail": "high"
              }
          }
      ]
  }

  Video URL

  Describes a video from an HTTP(S) URL.

  {
      "extractionGuidance": "Summarize the sequence of events.",
      "input": [
          {
              "type": "video_url",
              "video_url": {
                  "url": "https://example.com/video.mp4"
              }
          }
      ]
  }

• $.presetstring

  Optional processing preset: auto or high.

• $.extractionGuidancestring

  Optional instruction that guides the description.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Request parameters:

• $.modelstring

  Optional speech-to-text model identifier.

• $.input_audioobjectRequired

  Base64-encoded audio and its format.

• $.input_audio.datastringRequired

  Base64-encoded audio bytes.

• $.input_audio.formatstringRequired

  Audio format: wav, mp3, m4a, flac, ogg, webm or aac.

• $.languagestring

  Optional language hint.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• offsetminutesinteger

  Lookback window in minutes when timeStart is omitted. Defaults to 120 and is limited by the account conversation retention period.

• timeStartstring

  Inclusive ISO 8601 start date, limited by the account conversation retention period.

• timeEndstring

  Inclusive ISO 8601 end date. Defaults to the current time and must not precede timeStart.

• filterstring

  Optional command-line style filters. Supported filters: --model|-m, --user|-u, --api-key, --gateway, --chat-client, and --chat-session.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the conversation to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the conversation to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• iduuid

  Identifier of the conversation to export.

Query parameters:

• periodstring

  Retention guard period. Accepted values: 2h, 1d, 7d, or 30d. Defaults to 7d.

• mediastring

  Media export mode. Accepted values: text or include. Defaults to text.

• thinkingstring

  Reasoning export mode. Accepted values: visible, all, or none. Defaults to visible.

• truncateinteger

  Optional maximum token count for the exported conversation. Use 0 to disable truncation. Maximum value is 1,000,000.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• periodstring

  Export period. Accepted values: 2h, 1d, 7d, or 30d. Defaults to 7d and is limited by the account retention period.

• mediastring

  Media export mode. Accepted values: text or include. Defaults to text.

• thinkingstring

  Reasoning export mode. Accepted values: visible, all, or none. Defaults to visible.

• truncateinteger

  Optional maximum token count per exported conversation. Use 0 to disable truncation. Maximum value is 1,000,000.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to inspect.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to empty.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection whose vectors should be rebuilt.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to inspect.

Query parameters:

• viewstring

  View mode. Accepted values: recent, low-quality, or high-quality.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to export.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to de-duplicate.

Query parameters:

• deltastring

  Duplication sensitivity. Accepted values: low, medium or high. Defaults to medium.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to de-duplicate.

Query parameters:

• deltastring

  Duplication sensitivity. Accepted values: low, medium or high. Defaults to medium.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection to inspect.

Query parameters:

• viewstring

  View mode. Accepted values: recent, low-quality, or high-quality.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• collection-iduuid

  Identifier of the collection that owns the transaction.

• transaction-idinteger

  Identifier of the RAG transaction.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• filterstring

  Optional search over job id or title.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Query parameters:

• filterstring

  Optional search over workflow id, title, model name or instruction text.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the workflow to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the workflow to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the workflow to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

Query parameters:

• filterstring

  Optional search over job id or title.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job to delete.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job that will receive items.

Request parameters:

• modestring

  Import mode: lines, files, zip, or text. Defaults to lines when omitted.

• itemsfile

  The uploaded file or files. In lines mode, each non-empty line is imported. In files mode, each file is imported as one item. In zip mode, each text entry is imported as one item.

• documentsfile

  Accepted alias for the items file field.

• textstring

  Manual item input for text mode.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job whose items will be listed.

Query parameters:

• statestring

  Optional item state filter, such as Pending, Finished, ExecutionError or ValidationError.

• confidencestring

  Optional confidence filter. Accepted values: high, high-confidence, low or low-confidence.

• filterstring

  Optional text search over item input.

• sortstring

  Item ordering. Accepted values: inserted-desc, inserted-asc, processed-desc or processed-asc. Defaults to inserted-desc.

• limitinteger

  Maximum number of items to return. The endpoint enforces an upper bound.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job whose items will be removed.

Query parameters:

• modestring

  Deletion mode. Accepted values: pending, finished, errors or all.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job whose items will be retried.

Query parameters:

• modestring

  Retry mode. Accepted values: errors, execution-error, validation-error or low-confidence.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the batch job to export.

Query parameters:

• statestring

  Export state filter. Use all, finished, failed, errors, success or an item state name.

• confidencestring

  Optional confidence filter. Accepted values: high, high-confidence, low or low-confidence.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the parent batch job.

• item-iduuid

  Identifier of the batch item to retrieve.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the parent batch job.

• item-iduuid

  Identifier of the batch item to update.

Headers:

• AuthorizationRequired

  The API key used to authenticate the request. Can be provided as a query parameter (api-key).

Path parameters:

• workflow-iduuid

  Identifier of the parent workflow.

• job-iduuid

  Identifier of the parent batch job.

• item-iduuid

  Identifier of the batch item to delete.